| Synopsis: | Comments related Items |
| Description: |
| This chapter concerns comments in the code. Comments highly increase the readability and maintainability of the code. |
| Name | Checked | Synopsis |
|---|---|---|
| COM#001 |  |
Every file that contains source code must be documented with an introductory comment that provides information on the file name and its contents |
| COM#002 | |
All files must include copyright information |
| COM#003 | |
All comments are to be written in English |
| COM#004 | |
Use // for comments |
| COM#005 | |
Do not leave commented-out code in the source file |
| COM#007 | Use //====== for block comments at global scope |