Leanpub Header

Skip to main content

A Short Guide to Naming

Understand how and why to better name modules, classes, functions, and variables.

if you've read my chapter on naming in a famous software book (first or second edition) you may want to go a little deeper. Same author, same topic, all-new content!

Free With Membership

With Membership

Free!

$20.00

You pay

$20.00

Author earns

$16.00
$

...Or Buy With Credits!

You can get credits with a paid monthly or annual Reader Membership, or you can buy them here.
PDF
EPUB
WEB
About

About

About the Book

Tim has been writing about naming variables, classes, modules, and functions since the 1980s, and has never stopped reaching new understandings and observations.

Many people refer to naming as one of the most difficult problems in the software industry, and many people have surrendered to the idea that it can't be done. In this book, decades of experience are gathered to describe the how and why based on principles that make a difference to programmers in real codebases around the world.

It's not just another person's preferences, but a way of understanding naming that will open up your team's ability to make choices that work for your people in your project.

Author

About the Author

Tim Ottinger

Tim is a long-time coder, team leader, coach, and consultant.

He is one of the crew of experts at Industrial Logic, a premier agile consultancy, eLearning vendor, and thought leader. Here Tim joins with Bill Wake, Joshua Kerievsky, and a host of other industry experts to help people develop the skills that will make them sustainably great.

Tim is a co-author of Agile In A Flash and is featured as the author of chapter 2 of Clean Code. He also is the author of the Vim tutorial Use Vim Like A Pro, which has recently migrated from a blog article to a LeanPub book.

He writes code. He likes it.

Contents

Table of Contents

Foreword

Introduction: What This Book Assumes

  1. The Foundation We Build Upon
  2. So why should we consider naming?

What is the Point?

  1. Arguing Against Naming Skill
  2. Does it Actually Matter?
  3. Features of Good Names

Readability as a Matter of Familiarity

  1. The Relationship Nature of Readability
  2. The Team as the Audience
  3. Profitable vs. Unprofitable Struggle
  4. Building Shared Familiarity
  5. Practical Guidelines

Context Creates Clarity

  1. The Hierarchical Nature of Code
  2. What is the domain name associated with this concept?
  3. Windshield Naming
  4. Unnecessary Context
  5. The Context Hierarchy
  6. The Variable Name Sweet Spot
  7. Domain Context: Speaking the Language
  8. Process Context: Understanding the Flow
  9. Mathy or Prosey?
  10. When to Use Minimal Names
  11. When Context Is Mixed
  12. Practical Guidelines for Context-Aware Naming

Length of Names

  1. The Factors To Consider
  2. So, No Single-Letter Identifiers?
  3. @ A name carries meaning

@@ Redundant Context Carries No Meaning

  1. Primacy
  2. Programming Nicknames

Rules of Thumb

Extraction and Naming - Two Sides of the Same Coin

  1. The Dual Nature of Code Organization
  2. Paragraph markers
  3. Naming Complex Expressions
  4. When Functions Aren’t Enough: Extracting Classes
  5. Cohesion: The Principle Behind Good Extraction
  6. The Naming-Extraction Feedback Loop
  7. Practical Guidelines for Extraction and Naming

Nouns And Verbs

  1. The Nouns
  2. The Verbs
  3. Other Parts Of Speech
  4. Frameworks

Rules of Thumb

Incrementalism

  1. Naming is a Process
  2. Intentionally Bad Names
  3. Obviously Temporary Names
  4. Renaming Safely
  5. Caveats
  6. The Art of Incremental Improvement

Conclusion

  1. Key Takeaways
  2. The Naming Checklist
  3. Moving Forward
  4. Further Reading

Get the free sample chapters

Click the buttons to get the free sample in PDF or EPUB, or read the sample online here

The Leanpub 60 Day 100% Happiness Guarantee

Within 60 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.

Now, this is technically risky for us, since you'll have the book or course files either way. But we're so confident in our products and services, and in our authors and readers, that we're happy to offer a full money back guarantee for everything we sell.

You can only find out how good something is by trying it, and because of our 100% money back guarantee there's literally no risk to do so!

So, there's no reason not to click the Add to Cart button, is there?

See full terms...

Earn $8 on a $10 Purchase, and $16 on a $20 Purchase

We pay 80% royalties on purchases of $7.99 or more, and 80% royalties minus a 50 cent flat fee on purchases between $0.99 and $7.98. You earn $8 on a $10 sale, and $16 on a $20 sale. So, if we sell 5000 non-refunded copies of your book for $20, you'll earn $80,000.

(Yes, some authors have already earned much more than that on Leanpub.)

In fact, authors have earned over $14 million writing, publishing and selling on Leanpub.

Learn more about writing on Leanpub

Free Updates. DRM Free.

If you buy a Leanpub book, you get free updates for as long as the author updates the book! Many authors use Leanpub to publish their books in-progress, while they are writing them. All readers get free updates, regardless of when they bought the book or how much they paid (including free).

Most Leanpub books are available in PDF (for computers) and EPUB (for phones, tablets and Kindle). The formats that a book includes are shown at the top right corner of this page.

Finally, Leanpub books don't have any DRM copy-protection nonsense, so you can easily read them on any supported device.

Learn more about Leanpub's ebook formats and where to read them

Write and Publish on Leanpub

You can use Leanpub to easily write, publish and sell in-progress and completed ebooks and online courses!

Leanpub is a powerful platform for serious authors, combining a simple, elegant writing and publishing workflow with a store focused on selling in-progress ebooks.

Leanpub is a magical typewriter for authors: just write in plain text, and to publish your ebook, just click a button. (Or, if you are producing your ebook your own way, you can even upload your own PDF and/or EPUB files and then publish with one click!) It really is that easy.

Learn more about writing on Leanpub