C/C++ 程序员编程规范之注释（参考）

编程规范(注释)

注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。

---

说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释.

     注释适当列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。

源文件头部也应进行注释.

     列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。