C++中的代码注释

文件头注释

/*! @file ******************************************************************************** <PRE> 模块名       :  文件名       :  相关文件     :  文件实现功能 :  作者         : <xxx> 版本         : 1.0 -------------------------------------------------------------------------------- 多线程安全性 :  异常时安全性 :  -------------------------------------------------------------------------------- 备注         :  -------------------------------------------------------------------------------- 修改记录     :  日 期        版本   修改人         修改内容  YYYY/MM/DD   1.0    <xxx>           创建 </PRE> ******************************************************************************** * 版权所有(c) YYYY, <xxx>, 保留所有权利 *******************************************************************************/

　

标准类注释

以下定义的各种成员类型可以根据实际需要增删。

/*! @class ******************************************************************************** <PRE> 类名称   :  功能     :  异常类   :  -------------------------------------------------------------------------------- 备注     :  典型用法 :  -------------------------------------------------------------------------------- 作者     : <xxx> </PRE> *******************************************************************************/ class CXXX { public: /// 类型定义 public: / 构造、析构、初始化 public: / 虚函数 public: /// 公用方法 public: /// 静态方法 protected: /// 内部方法 private: /// 私有类型定义 private: /// 私有方法 private: /// 属性 private: /// 静态属性 private: / 禁用的方法 };

　

标准函数注解

/*! @function ******************************************************************************** <PRE> 函数名   :  功能     :  参数     :  返回值   :  抛出异常 :  -------------------------------------------------------------------------------- 复杂度   :  备注     :  典型用法 :  -------------------------------------------------------------------------------- 作者     : <xxx> </PRE> *******************************************************************************/

　

语句/函数组

// [[ 这组语句或函数的功能     ... // ]] 这组语句或函数的功能 或 // ---- [[ 这组语句或函数的功能     ... // ---- ]] 这组语句或函数的功能

　

语句块

// ========================================================================= // = 说明由此以下一系列语句执行的操作 // @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ // @@ 说明由此以下一系列特别语句执行的操作 // @@ 说明由此以上一系列特别语句执行的操作 // @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

　

分割带

// ############################################################################# // ############################################################################# // ############################################################################# // ############################################################## 本地数据和函数     ... // ############################################################## 本地数据和函数 // ############################################################################# // ############################################################################# // ############################################################## Cxxx类成员定义     ... // ############################################################## Cxxx类成员定义 // ############################################################################# // ############################################################################# // ################################################################ 其它部分开始     ... // ################################################################ 其它部分结束 // #############################################################################