Comments
- Details
- Category: Programming
- Published on Tuesday, 16 August 2011 02:09
- Written by Kinda Strange
- Hits: 246
Writing code includes adding internal documentation in the form of comments. Comments are notes within the code that explain the purpose of the code.
It is good programming practice to include a comment header at the beginning of every class or file. The comment header identifies the file, it's purpose, and usually it's author and the date of creation. Comments help during the reviewing and debugging process, identifying what the program is going to do and assisting the programmer in thinking clearly about the purpose of the code.
A comment should be placed at the beginning of code for each event and method. Comments should also be placed near portions of code that require clarification or that serve an importantpurpose.
Comments display in the coding window and on source code printouts, but do not cause the program to perform a task. They are not executed when the program runs.
