Use comments

Commentsaren't a replacement for reading the code; source code should be as readable as possible. However, the source code isn't capable of representing all information concerning a subtle implementation. If source code isn't completely obvious, include a comment.

Make comments short and informative, and echo the code as little as possible. As a rule of thumb, if you must read the code a couple of times to figure out what is happening, include a comment.

[Contents] [Previous] [Next]
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.

Generated with WebMaker