C/C++ 注释规范

基于Doxygen平台的注释规范

Doxygen是一种开源跨平台的，以类似JavaDoc风格描述的文档系统，完全支持C、C++、Java、Objective-C和IDL语言，部分支持PHP、C#。鉴于Doxygen良好的注释风格，故基于Doxygen以形成自己的注释规范。

1. 文件头的标注

/*****************************************************************************
*  @file     Example.h                                                       *
*  @brief    对文件的简述                                                     *
*  Details.                                                                  *
*                                                                            *
*  @author   Henry.Wen                                                       *
*  @version  1.0.0.1(版本号)                                                 *
*****************************************************************************/

2.命名空间

/**
 * @brief 命名空间的简单概述 
 * 命名空间的详细概述
 */
namespace OST
 {
 }

3. 类、结构、枚举标注

/**
 * @brief 类的简单概述 
 * 类的详细概述
 */
class Example
 {
 };
//枚举类型定义、结构体类型定义注释风格类似

4. 函数注释原则

/** 
 * @brief 函数简要说明-测试函数
 * @param index    参数1
 * @param t        参数2 @see CTest
 *
 * @return 返回说明
 *     -<em>false</em> fail
 *     -<em>true</em> succeed
 */
bool Test(int index, const CTest& t);

以上是博主参考网友博客并提取出常用几点，详细看原文：

链接: link.