Code Standards

INTERNAL (CODE) DOCUMENTATION:

To add documentation internally with the code usually goes without saying, nevertheless, this project being "open source," seems to make it ever more important to document well.

Generous code comments should have a synergistic effect, and make the entire project better.

Each code block, module, or minor routine, should contain *clear* and descriptive comments within it, describing what the block does (or is supposed to do. Heh, heh.)

This is just as important for the coder as it is for others who will view the code, as each programmer knows that he/she might return to correct or refine their code later.

You may want to consider read Code Complete (a code construction handbook... very good). You may also want to read a short article on PDL which stands for Program Design Language and provides an easy to use methodology to self documenting code.