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 名字空间注释规范 .....................
