The Hardest Problem in Software Engineering
About the Book
Naming is one of the most difficult and enduring challenges in software engineering, but few of us do it well. This practical and comprehensive book provides a set of principles, rules, and application guidelines for efficiently choosing good names in your code.
These skills can be used throughout your career, and they’re useful for every programming language, technical domain, and experience level. The book incorporates real-world examples to illustrate how to choose good names and avoid bad names.
This book includes:
- Rules for how to choose good names and avoid bad names
- Principles to help you remember the general qualities of good names
- Real-world examples
- Guidelines on the application of these rules and principles, including balancing tradeoffs, renaming best practices, and choosing domain-specific names
- Tips on how to develop your naming skills throughout your career
Printed copies of this book are available on Amazon.
Table of Contents
- 1. Purpose of this book
2. Why is naming important?
- 2.1. Understandable code
- 2.2. Productivity and happiness
- 2.3. Career growth
3. Why is naming hard?
- 3.1. Dynamic, subjective requirements
- 3.2. Insufficient best practices and tooling
- 3.3. Short-term costs and long-term value
- 3.4. How can we make naming easier?
- 4. Scope of this book
- 5.1. List of principles
- 6.1. Overview
- 6.2. Rules
- 7.1. Overview
- 7.2. Rules
- 8.1. Overview
- 8.2. Rules
- 9.1. Overview
- 9.2. Rules
- 5. Overview
- 10. Overview
- 11.1. Overview
- 11.2. Consistency vs. other principles
- 11.3. Understandability vs. Conciseness
- 11.4. Understandability vs. Distinguishability
- 11.5. Conciseness vs. Distinguishability
12. Identifier types
- 12.1. Overview
- 12.2. Classes
- 12.3. Variables
- 12.4. Methods
- 12.5. Method arguments
- 12.6. Interfaces
- 12.7. Constants
- 12.8. Packages/modules/namespaces
- 13. Style guides
14. Controlled vocabularies
- 14.1. Evolution of controlled vocabularies
- 14.2. Further reading
- 15.1. Scope
- 15.2. Principal and interest
- 15.3. Process
16. Domain-specific names
- 16.1. Consult domain-related resources
- 16.2. Consult domain experts
- 16.3. Consult team members
17. Developing naming skills
- 17.1. Improving your naming skills
- 17.2. Improving your team’s naming skills
- 18. Common antonyms
- 19. Visually similar characters
20. Rejected principles
- 20.1. Length
- 20.2. Searchability
- 20.3. Pronounceability
- 20.4. Meaningfulness
- 20.5. Austerity
- 20.6. Accuracy
- 20.7. Precision
- 20.8. Concision
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.
See full terms
80% Royalties. Earn $16 on a $20 book.
We pay 80% royalties. That's not a typo: you earn $16 on a $20 sale. If we sell 5000 non-refunded copies of your book or course for $20, you'll earn $80,000.
(Yes, some authors have already earned much more than that on Leanpub.)
In fact, authors have earnedover $12 million USDwriting, 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