by shigemk2


97 Things Every Programmer Should Know 62 Only the Code Tells the Truth

THE ULTIMATE SEMANTICS OF A PROGRAM is given by the running code.

With this in mind, ask yourself how clearly your code is telling you or any other programmer what it is doing.

Treat your code like any other composition, such as a poem, an essay, a public blog, or an important email.

Craft what you express carefully, so that it does what it should and communicates as directly as possible what it is doing; so that it still communicates your intention when you are no longer around. Remember that useful code is used much longer than ever intended. Maintenance programmers will thank you.

Establish some sanity in the code, and keep your own sanity.