TICS Coding Standard Viewer 
TIOBE Software Quality Framework
Print-friendly version
©TIOBE Software www.tiobe.com
 
C++ Coding Standard
Search

Category: Comments

Synopsis:Comments related Items


Description:
This chapter concerns comments in the code. Comments highly increase the readability and maintainability of the code.

Coding Rules

NameCheckedSynopsis
COM#001 Checked automatically with code checker 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 Checked automatically with code checker All files must include copyright information
COM#003 Checked automatically with code checker All comments are to be written in English
COM#004 Checked automatically with code checker Use // for comments
COM#005 Checked automatically with code checker Do not leave commented-out code in the source file
COM#007 Use //====== for block comments at global scope