Things I Love to See in Source Code...
Following are just a few of the many things I really love to see in someone else's code that I have to take over for maintenance.
- consistent identifier naming: varName, VarName and var_name all in one class
- indentation done with spaces, preferrably two spaces per indentation step
- large commented-out code blocks
- half of the code being commented-out print and logging statements
- one-line methods, introduced with the comment NOT USED NOT USED NOT USED NOT USED ...
- misspelled identifier names
- non-English (preferrably French) comments
- ...
All seen in production code near you...
Posted by guenter at March 8, 2005 01:12 PM