Difference between revisions of "Best Coding Practices"
From Coder Merlin
Line 6: | Line 6: | ||
** ''verbs'' are usually most appropriate | ** ''verbs'' are usually most appropriate | ||
* Appropriate use of functions | * Appropriate use of functions | ||
** In general, avoid mid-function exits | |||
* Avoid repetition | |||
** DRY: Do Not Repeat Yourself | ** DRY: Do Not Repeat Yourself | ||
** DIE: Duplication is Evil | ** DIE: Duplication is Evil | ||
* Appropriate scoping | * Appropriate scoping | ||
** Scope is no wider than absolutely necessary | ** Scope is no wider than absolutely necessary |
Revision as of 21:00, 16 April 2019
Within these castle walls be forged Mavens of Computer Science ...
— Merlin, The Coder
- No global variables
- Appropriate capitalization
- Appropriate and descriptive variable names
- nouns are usually most appropriate
- Appropriate and descriptive function names
- verbs are usually most appropriate
- Appropriate use of functions
- In general, avoid mid-function exits
- Avoid repetition
- DRY: Do Not Repeat Yourself
- DIE: Duplication is Evil
- Appropriate scoping
- Scope is no wider than absolutely necessary
- Appropriate loops
- Correct loop type
- In general, avoid mid-loop exits
- Appropriate indentation
- Helpful whitespace
- Appropriate placement of closing braces and parentheses
- Appropriate use of preconditions
- Deliberate and helpful comments
- Avoid "obvious" comments
- Avoid deep nesting
- Avoid inappropriate nesting of functions
- Limit line length
- Appropriate file organization
- Generally one class per file
- Code is clear and concise