doxygen注释规范示例（C++）

doxygen能根据code的注释自动生成code的帮助文档，并且doxygen是一个跨平台的开源的软件，但是要生成帮助文档，code内的注释必须按一定规则书写。下面是我总结的c/c++的注释书写规范，代码风格结合了google c++风格。

/**                                   | 文件注释* @file apply.c                      | “@file”后的文件名需与当前文件名一致* @author clover/clover@123.com* @version 1.0* @date 2013-12-12* @brief 概述：doxygen使用文档* 详细介绍了doxygen的C++注释方法* @details 详细说明* @see MainWindow参考其它的相关的函数，这里作一个链接 url* @note 描述需要注意的问题*//// This macro is toolong, so comment here briefly!     | 推荐使用简洁的宏注释
#define HTTP_REQUEST_LEN_MAX    APPLY_BUF_SIZE_BIG
/*** The detail macro comment, may be multi-line.  | 尽量少写宏函数，可以使用内联函数代替* @param a The brief parameter comment* @param b The brief parameter comment* @return The brief return value comment*/
#define MAX(a, b) ((a) > (b))? (a) : (b)/*** @brief 结构体                          | 结构体成员的详细注释写在该成员上面* (与名称后面的描述有一个就可以)           | 结构体成员的详细注释与上一成员间留1个空行*                                        | 推荐使用简洁的结构体注释*/
struct StructVariable {    ///  @brief 简单的描述   |  “///”与注释间留有2个空格int a;      ///< variable a                     |  “///<”与注释间留有1个空格int b;      ///< variable b/** this is details mement comment */int c;      ///< variable cint d;      ///< variable d
};/** * @enum 性别枚举*/
enum Sex {  ///  @enum 性别枚举kMale,   ///< enum malekFemale  ///< enum female
};/***  @brief 主窗口*/
class MainWindow : public QMainWindow
{Q_OBJECTpublic:MainWindow(QWidget *parent = 0);~MainWindow();bool SetProName(QString name);  ///< 设置工区名称private:QString m_name_;
};/// @brief 函数名称：setProName
static int ApplyLogin();
/*** @brief 函数名称：setProName                      |尽量避免函数声明和定义重复注释* @todo 代码实现的功能: 设置工区名称* @param 参数：QWidget** @return 说明：int* @retval 1. true 名字设置成功  (返回值说明(可选))* @retval 2. false 名字设置失败* @bug 此处的bug描述: 无*/
bool MainWindow::SetProName(QString name)
{
}// 其它注释// 代码中其余注释一律使用普通的单行注释“//”和多行注释“/*”“*//* * Doxygen 会忽略你注释中的换行符，将多行注释连接成一个连续行并使用空格隔开。* 如果你希望保留两行注释之间的换行，需要在该行末加入“/n”。* * 常用命令* @attention           注意* @author              作者* @bug                 缺陷，链接到所有缺陷汇总的缺陷列表* @brief               简要注释* @code                代码块开始，与“endcode”成对使用* @endcode             代码块结束，与“code”成对使用* @details             详细注释* @date                日期* @file                < 文件名> 文件参考，用在文件注释中* @param               参数，用在函数注释中* @return              返回，用在函数注释中* @todo                TODO，链接到所有TODO 汇总的TODO 列表* @version             版本* @warning             警告*/

doxygen注释规范示例（C++）相关推荐

doxygen 注释规范_编程规范 - doxygen注释规范示例（C++）
doxygen注释规范示例(C++) doxygen能根据code的注释自动生成code的帮助文档,并且doxygen是一个跨平台的开源的软件,但是要生成帮助文档,code内的注释必须按一定规则书写. ...
c代码Doxygen注释规范
c代码Doxygen注释规范前言:良好得注释风格利于后期维护和团队协作开发,使得代码逻辑清晰,意图明了.Doxygen是一种能自动提取代码内注释生成版主文档的开源软件,它是跨平台的.非开源项目也许并 ...
使用VA助手如何快速添加注释(按doxygen注释规范)
原文首发于微信公众号「3D视觉工坊」:使用VA助手如何快速添加注释(按doxygen注释规范) 首先,关于VA助手的破解安装教程,请参考:VS2015 Visual Assist X 破解版安装教程 ...
c++ doxygen 注释规范_C语言代码注释参考
简述该参考是基于Doxygen注释规范进行简单归纳,可以适当根据自己的需求进行约定. Doxygen可以从一套归档源文件开始,生成HTML格式的在线类浏览器,或离线的LATEX.RTF参考手册.简单 ...
c++ doxygen 注释规范_[代码规范]Go语言编码规范指导
本规范旨在为日常Go项目开发提供一个代码的规范指导,方便团队形成一个统一的代码风格,提高代码的可读性,规范性和统一性.本规范将从命名规范,注释规范,代码风格和 Go 语言提供的常用的工具这几个方面做一 ...
c++ doxygen 注释规范_利用Doxygen给C程序生成注释文档
利用Doxygen为C程序生成注释文档一.Doxygen工具的安装利用Doxygen工具生成API帮助文档需要下载安装以下三个软件: (1)Doxygen:可以从一套归档源文件开始,生成HTML格 ...
代码注释规范之Doxygen
一 Doxygen简介 Doxygen是一个程序的文档产生工具,可以将程序中的注释转换成说明文档或者说是API参考手册,从而减少程序员整理文档的时间.当然这里程序中的注释需要遵循一定的规则书写,才能让 ...
doxygen常用代码注释标记示例说明
目录类.结构体公有函数.全局函数枚举公有成员变量.全局常量常见问题如何在注释文件中添加表格如何在注释中分条列举如何给描述内容分段 Doxygen 常用的代码注释标记介绍类.结构体类 ...
详细聊聊Javadoc注释规范
Javadoc 注释规范 1. 注释分类 2. Java文档和Javadoc 3. 文档注释的格式 3.1 文档和文档注释的格式化 3.2 文档注释的三部分 4. 使用Javadoc标记 4.1 ...

doxygen注释规范示例（C++）

doxygen注释规范示例（C++）相关推荐

最新文章

热门文章