next up previous
Next: Compiler warnings Up: Prevention Previous: Comments

Readable code

In addition to adding good comments to your code, you should attempt to create readable code, which allows for pieces of underlying algorithms to be more easily understood. Readable code consists mainly of meaningful identifiers for functions and variables and a healthy amount of spacing between and within lines. Modern compilers have a great advantage over older compilers in that identifiers are not limited in length. Accordingly, use identifiers that are easy to recognize and that even contain meaning within the context of the physical problem. Even for Fortran, notoriously opaque, current compilers have a much relaxed syntax, such as allowing for arbitraryily sized identifiers and disapperance of special columns.



Spencer Eugene Olson 2005-01-19