Software Design Naming And Comments

Goal

Make code easier to understand by choosing precise names and comments that explain what the code cannot say clearly by itself.

Naming Checks

• Names create the right mental image.
• Similar things use consistent terms.
• Different things do not share near-identical names.
• Names describe domain meaning, not incidental implementation.
• Booleans read naturally at call sites.
• Generic names are used only for truly generic concepts.

Comment Checks

Use comments for: