Difference between revisions of "Best Coding Practices"
From Coder Merlin
(Created page with "* No global variables * Appropriate and descriptive variable names * Appropriate and descriptive function names * Appropriate use of functions ** DRY: Do Not Repeat Yourself *...") |
|||
| Line 10: | Line 10: | ||
* Appropriate use of preconditions | * Appropriate use of preconditions | ||
* Deliberate and helpful comments | * Deliberate and helpful comments | ||
** Avoid "obvious" comments | |||
* Avoid deep nesting | * Avoid deep nesting | ||
* Limit line length | * Limit line length | ||
* Appropriate file organization | * Appropriate file organization | ||
** Generally one class per file | ** Generally one class per file | ||
Revision as of 08:47, 5 April 2019
Within these castle walls be forged Mavens of Computer Science ...
— Merlin, The Coder
- No global variables
- Appropriate and descriptive variable names
- Appropriate and descriptive function names
- Appropriate use of functions
- DRY: Do Not Repeat Yourself
- DIE: Duplication is Evil
- 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
- Limit line length
- Appropriate file organization
- Generally one class per file
