However, there are a certain cases when globals might be used. All use of globals must be completely documented and justified. 10.0 Comments Comments can be divided into two general categories, strategic and tactical. Strategic comments are used to give the reader a general overview of what is going on. These comments appear at the top of the files and before the function code.
Strategic comments tend to be written in a prose style.
Tactical comments are designed to explain tricky areas of code, what parameters do, and hints about the control flow of the program. These comments are imbedded in the code and tend to be shorter and in bullet format. The javadoc will be used to develop documentation files. If you use proper naming, block structure, indentation, and straight forward programming, your code will be mostly self documenting. This is what you should strive for.