c++注释规范-reactosjira.docVIP

C++注释规范 版本：1.0 制定部门：技术架构部C++基础架构组 2006.8 目录 1 说明 3 2 注释种类 3 2.1 重复代码 3 2.2 解释代码 3 2.3 代码标记 3 2.4 概述代码 3 2.5 代码意图说明 4 2.6 传达代码无法表达的信息 4 3 注释原则 4 3.1 站在读者的立场编写注释 4 3.2 注释无法取代良好的编程风格 4 3.3 好注释能在更高抽象层次上解释我们想干什么 5 4 规范细则 5 4.1 文件注释规范 5 4.2 名字空间注释规范 6 4.3 类定义注释规范 7 4.4 数据声明注释规范 8 4.5 函数注释规范 8 4.6 代码标记注释规范 10 5 FAQ 10 5.1 枚举值需要注释吗？ 10 5.2 前置条件、后置条件和不变式有必要注释出来吗？ 10 5.3 写注释太耗时间怎么办？ 11 5.4 有效的注释是指什么？ 11 参考书目 11 参考工具 11 1 说明 本文档用于规范C++代码注释。规范中提出的多数注释格式都来源于文档生成工具doxygen，所以遵从本规范进行注释的C++代码都可以使用doxygen生成美观一致的代码文档。同时另一方面，美观绝非衡量文档质量的唯一标准。文档内容准确与否，是否充分，语言组织是否清晰流畅，都是决定一份文档质量的重要标准。遗憾的是，这些标准当中有不少通过主观加以判断，很难明确规范。所