Doxygen注释的风格

Doxygen常用注释语法 阅读详情

1      JavaDoc风格的注释

1.1    概述

JavaDoc 风格的注释风格主要使用下面这种样式: 即在注释块开始使用两个星号 ‘ * ‘

 /**   description     

  *    description     

  *    description     

 */

1.2    简述与详述的方式

Doxygen 支持的块(类、函数、结构体等)的注释描述分为两种:简述  和  详述

一般注释的描述由简述开始,经过特殊分隔方式后,后面紧跟详述的内容, javaDoc 风格可以使用的分隔方法有以下两种:

1)        使用  \brief  参数标识,空行作为简述和详述的间隔标识

/*!    @brief  Brief description. 

 *    description continued. 

 * 

 *    Detailed description starts here. 

 */

2) 直接使用javaDoc风格,javaDoc风格自动以简述开头,以空行(或者小数点加空格)作为简述与详述的分割

/**    Brief description 

 *    description continued 

 * 

 *    Detailed description starts here. 

 */

/**        Brief description 

 *         description continued . (注意:这里有一个小数点,加上一个空格) 

 *         Detailed description starts here. 

 */

1.3   文件头注释示例

 gtest-1.6.0.rar

1.4   类定义注释示例

/**    本类的功能:打印错误信息 

 *  

 *     本类是一个单件 

 *     在程序中需要进行错误信息打印的地方 

 */

class CPrintError 

{ 

            …… 

}

1.5   类成员变量定义示例

( 1 )在成员变量上面加注释的格式

/** 成员变量描述 */

int  m_Var;

( 2 )在成员变量后面加注释的格式 

int  m_color;     /**< 颜色变量 */

 

1.6   成员函数的注释示例

/** 下面是一个含有两个参数的函数的注释说明(简述) 

 * 

 *     这里写该函数的详述信息 

 *     @param a 被测试的变量(param描述参数) 

 *     @param s 指向描述测试信息的字符串 

 *     @return    测试结果 (return描述返回值) 

 *     @see    Test()    (本函数参考其它的相关的函数,这里作一个链接) 

 *     @note    (note描述需要注意的问题) 

 */

int testMe(int a,const char *s);

1.7     枚举变量的注释示例

/**    颜色的枚举定义 

  *  

  *    该枚举定义了系统中需要用到的颜色\n 

  *    可以使用该枚举作为系统中颜色的标识 

  */

enum TEnum  

{  

     RED,           /**< 枚举,标识红色    */     

     BLUE,          /**< 枚举,标志蓝色    */     

     YELLOW         /**< 枚举,标志黄色. */     

}enumVar;

2      C++风格的注释

2.1    概述

C++ 的注释风格主要使用下面这种样式: 即在注释块开始使用三个反斜杠 ‘ / ’

其他地方其实与 JavaDoc 的风格类似,只是 C++ 风格不用  “ * ”  罢了。

2.2       简述与详述

C++ 风格的简述与详述方式与 javaDoc 类似。

一般注释的描述由简述开始,经过特殊分隔方式后,后面紧跟详述的内容, C++ 风格可以使用的分隔方法有以下两种:

(1) 使用  \brief  参数标识,空行作为简述和详述的间隔标识

 

///    \brief  Brief description. 

///    description continued. 

/// 

///    Detailed description starts here. 

///

( 2 )  使用以空行(或者小数点加空格)作为简述与详述的分割

 

///   Brief description 

///   description continued. 

///    

///   Detailed description starts here.

以小数点加空格作为分隔如下:

///         Brief description 

///         description continued . (注意:这里有一个小数点,加上一个空格) 

///         Detailed description starts here. 

///

2.3    注释风格约定

1. 一个代码块(类、函数、结构等)的概述采用单行的”///”加一个空格开头的注释,并写在该代码块声明的前面;

2. 一个代码块的详述采用至少两行的”///”加一个空格开头的注释,若不足两行第二行的开头也要写出来,并且放在代码块定义的前面;如果某代码没有声明只有定义或者相反,则在定义或者声明前面写上单行的概述+一个空行+多行的详述;

3. 枚举值列表的各项、结构域的各项等采用在本行最后添加”///<”加一个空格开头的注释;

4. 对变量的定义采用在变量上面加单行”///”加一个空格开头的注释(相当于是给改变量一个概述);

5. 函数的参数用”/// @param”+一个空格开头的行描述在函数的详述里面;

6. 函数的返回值用”/// @return”+一个空格开头的行描述在函数的详述里面;

7. 函数之间的参考用”/// @see”+一个空格开头的行描述在函数的详述里面;

8. 文件头的版权以及文件描述的注释参见例代码。

2.4       文件头注释示例

 

2.5       类定义注释示例

///    本类的功能:打印错误信息 

/// 

///    本类是一个单件 

///    在程序中需要进行错误信息打印的地方 

class CPrintError 

{ 

          …… 

}

2.6       类成员变量定义示例

( 1 )在成员变量上面加注释的格式

/// 成员变量描述 

int  m_Var;

( 2 )在成员变量后面加注释的格式 

int  m_color;     /// 颜色变量

2.7       成员函数的注释示例

/// 下面是一个含有两个参数的函数的注释说明(简述)  

///   

///     这里写该函数的详述信息   

///     @param a 被测试的变量(param描述参数)   

///     @param s 指向描述测试信息的字符串   

///     @return    测试结果 (return描述返回值)  

///     @see    Test()    (本函数参考其它的相关的函数,这里作一个链接) 

///     @note    (note描述需要注意的问题)   

int testMe(int a,const char *s);

2.8       枚举变量的注释示例

 

///    颜色的枚举定义 

///  

///    该枚举定义了系统中需要用到的颜色\n 

///    可以使用该枚举作为系统中颜色的标识 

enum TEnum  

{  

    RED,            ///< 枚举,标识红色      

    BLUE,           ///< 枚举,标志蓝色      

    YELLOW          ///< 枚举,标志黄色.      

} enumVar;

3     需要注意的问题

(1)Doxygen会忽略你在注释中加入的多余的换行,如果你希望保留两行注释之间的空行,那么,在该行加入\n

 

4      Doxygen使用的常见问题小结

4.1     中文问题:中文注释在文档中是乱码

解决:在expert中的INPUT选项页的INPUT_ENCODEING中填入“GB2312”,这样基于GB的文本编辑器生成的代码就可以正常使用了。

4.2    图形问题:无法绘制类图协作图等图形。

解 决:首先确保安装了graphviz for win,注意不是wingraphviz,后者是一个graphviz的com封装,但是doxygen并不是基于它开发的,所以装了也没用。然后在 expert的DOT_PATH中填入graphviz的安装路径。接着在wizard的diagram中选择需要生成的图形类别就可以了。

如果出现无法包含.map文件的错误,可以将工作目录设置成html,并将html中所有文件都清除再试。这个问题的原因还不太确定。

4.3    输出chm的问题:如何输出.chm文件

配置时注意expert中的HTML页:选中“GENERATE_HTMLHELP”,然后在CHM_FILE中填上想要的chm文件名。

HHC_LOCATION中输入hhc.exe文件的路径。hhc.exe可以通过安装HTML Help Workshop获得。

或者使用HTML Help Workshop来编译Doxygen生成的html文件夹中的.hhp文件,编译完成后即可在该html文件夹中找到对应的chm文件

4.4     Doxygen无法为DLL中定义的类 导出文档

例如:

class __declspec(dllexport) CClassName:public CObject

{

}

目前发现Doxygen无法识别出DLL中定义的类。


c++ doxygen 注释规范_转:基于 Doxygen 的 C++ 注释风格 Title: 基于 Doxygen 的 C++ 注释风格Date: 2015-01-13 18:00Category: LinuxTags: C++, comment styleSlug: doxygen_cpp_comment_styleAuthor: Qian GuSummary: 总结基于 Doxygen 的 C++ 注释规则本文内容参考自网上博客内容重新整理排版了一下。写本文的主要目的是备... 阅读详情

相关推荐

宏基因组功能注释实战:从CAZyme到VFDB的完整流程(含数据库下载与脚本优化)

本文详细介绍了宏基因组功能注释的完整流程,涵盖CAZyme、eggNOG、CARD和VFDB四大核心数据库的实战应用。从环境配置、数据库下载与预处理到注释流程执行与优化,提供了全面的操作指南和脚本优化建议,帮助研究人员高效完成宏基因组数据分析。特别针对CAZyme注释等关键步骤给出了参数优化方案和常见问题排查方法。

weixin_29289821的博客 299

Doxygen注释规范

0x20000000/*** @defgroup 定义log的级别* @{* @}*/0123/*** @defgroup 定义log的级别* @{* @}*//*** @param data 参数说明* @param len 参数说明/*** @param data 参数说明* @param len 参数说明/*** @param data 参数说明* @param len 参数说明/*** @param data 参数说明* @param len 参数说明。

weixin_67003440的博客 3113

TMS320F280049C 学习笔记21 交叉开关 Crossbar (X-BAR)

简单介绍了X-BAR。

whyorwhnt的专栏 2万+

【Doxygen】Doxygen使用配置及注释语法规范

本文记录了使用Doxygen的gui进行相关配置并生成对应注释文档的相关过程,解释了Doxygen的注释语法规范,并简单介绍了在vscode中配置插件的相关事项。

Stay_Hun_forward的博客 8066

从原理到调试:手把手教你用Matlab解码互补格雷码与相移码(附数据与常见错误排查)

本文详细介绍了如何使用Matlab解码互补格雷码与相移码,涵盖从原理到调试的全过程。通过实际案例和代码示例,帮助读者掌握结构光三维重建中的相位解包裹技术,并提供了常见错误排查与优化建议,提升解码效率与准确性。

weixin_29090917的博客 221

板蓝根挥发油微胶囊化技术及其在抗菌织物整理中的应用研究

微胶囊技术是一种通过成膜材料将具有反应活性或挥发性的液体或固体包封成微小颗粒的技术。该技术因其优异的缓释保护和物态改变性能,已在医药、食品、化妆品等多个领域得到广泛应用。本研究采用复凝聚法制备板蓝根挥发油的微胶囊,利用明胶和阿拉伯胶作为壁材,旨在提升其稳定性和抗菌性能。

qq_62634009的博客 585

使用Doxygen为C\C++代码写文档

Doxygen是这样的一个工具,在我们写代码的同时,加上特定的注释,然后,Doxygen就利用这些注释生成漂亮的程序文档。 Doxygen是GPL众多优秀软件中的一员,当然,不仅仅在Linux平台有Doxygen,Doxygen还有Windows版本,而且他还提供了一个图形界面Doxywizard,使得使用Docxygen 更加方便。 按照Doxywizard的步骤, ...

b69412267044401的博客 661

应用商店评论分析实战:Python逆向工程破解Google Play加密接口与NLP建模

在移动互联网时代,应用商店中的用户评论成为了开发者优化应用、提升用户体验的重要依据。然而,Google Play等应用商店对评论数据进行了加密处理,直接爬取难度较大。本文将介绍如何使用Python逆向工程破解Google Play的加密接口,实现对应用商店评论的实时采集,并结合NLP(自然语言处理)技术进行情感分析和主题建模,为开发者提供有价值的数据支持。

u014481728的博客 1350

python docx官网_【记录】尝试用DocxyGen为Python代码生成文档

【背景】之前折腾技术的时候,或多或少,知道一个东西:DocxyGen是用于从代码生成文档的。最近,又从:->该地址无效,但是自己手动输入地址,而找到:看到页面右下角,就显示了,此在线文档是通过DocxyGen去生成的。然后就打算去试试,抽空把我的python代码:通过DocxyGen去生成文档看看。【折腾过程】1.目前搜到的一些,有参考价值的资料:(1)官网:介绍了一些基本的使用方法。介绍了...

weixin_39548832的博客 552

30 中望CAD二次开发(ZRX C++)-windows下的qt开发

本文介绍了中望CAD在windows下,如何使用qt开发插件界面,给出了具体的编码步骤,并生成了模态对话框和非模态对话框,其中非模态对话框可以调用CAD命令,实现交互操作。

cilvsuanna的博客 191

SFT看这一篇就够了!万字长文:监督微调(Supervised Fine-Tuning, SFT)技术全解析【从理论到实战】

大家好,我是大 F,深耕AI算法十余年,互联网大厂技术岗。分享AI算法干货、技术心得。欢迎关注,一起探索技术的无限可能!

大F子的智能小课 714

doxygen教程之注释风格

doxygen是一个开源的C++接口文档生成工具。要使用doxygen生成接口文档,就必须遵循它的注释规范,本文对它的注释规范进行简单介绍。

clever101的专栏 1611

42、InfiniBand技术详解:QP状态机、操作及错误处理

本文深入解析InfiniBand技术中的核心组件QP(Queue Pair)状态机、工作请求处理机制、支持的操作类型及错误处理策略。详细介绍了QP的创建与状态转换流程,包括INIT、RTR、RTS等关键状态,并提供了状态修改的代码示例。文章还探讨了工作请求的发布、资源使用限制、围栏机制以及重试和RNR流程,帮助开发者理解通信可靠性保障机制。此外,涵盖了多播组的应用场景与API使用方法,并对比了用户空间与内核级RDMA API的调用差异,最后给出了实践建议和常见问题解答,为构建高性能分布式系统提供技术指导。

oauth7security的博客 133

代码注释你写对了吗? Doxygen 风格注释,一目了然!

本文围绕 C/C++ 注释规范,介绍了 Doxygen 风格注释。先说明其是标准化格式,可生成结构化文档,支持多种语言,核心是特定标签。接着详细列出文档结构、函数方法等八类标签及使用提示。然后阐述使用方法,包括文件头部、类、函数等多种场景的注释要点与示例,还提及注释风格约定、禁忌及 C++ 特殊注意事项,最后提到相关工具链支持。

memoryfurong的博客 3714

win10 跳过U8环境检测的IE WebControls.rar

win10 安装u8的时候 提示IE WebControls 不通过,这个工具可以欺骗u8的检查。 跳过U8环境检测的IE WebControls。提示导入失败后,重新检测通过。

ssm框架搭建

这个是一个在idea上成功跑起来的ssm框架项目,保存在这里方便以后使用直接下载

doxygen 注释规范_Doxygen详细介绍(三)(Doxygen注释风格)

5Doxygen的注释风格5.1综述在每个代码项中都可以有两类描述,这两类描述将在文档中格式化在一起:一种就是brief描述,另一种就是detailed。两种都是可选的,但不能同时没有。顾名思义,简述(brief)就是在一行内简述地描述。而详细描述(detailed description)则提供更长,更详细的文档。Doxygen支持c风格注释、c++风格注释以及javaDoc风格注释等,下面将分...

weixin_39862716的博客 722

霍尼韦尔SoftMaster使用说明

霍尼韦尔SoftMaster使用说明

Doxygen注释风格终极指南:Qt风格vs JavaDoc风格深度对比

想要为你的C++项目生成专业文档?Doxygen工具是首选!作为开源文档生成器,Doxygen支持多种注释风格,其中Qt风格和JavaDoc风格最受欢迎。本文将为你详细对比这两种主流注释风格,帮助你选择最适合项目的文档方案。🚀 ## 什么是Doxygen注释风格? Doxygen通过解析代码中的特殊注释来生成文档。不同的注释风格会影响文档的可读性、维护性和团队协作效率。让我们从基础开始了解这

gitblog_00212的博客 731

符合 Doxygen 注释风格的 SourceInsight 宏

Source-Insight-Macro 一、简介 1.自定义组织信息 2.Doxygen风格的函数注释以及Todo标签 3.Doxygen格式的单行注释风格 二、FAQ 1.关于SourceInsight版本问题 2.关于Doexgen使用问题 三、参考与链接 Source-Insight-Macro 一、简介   该仓库旨在为 C/C++ 的开发人员提供一套符合 Doxygen...

Litost_Cheng的博客 2632

Doxygen注释风格生成C语言程序文档

为了能够养成良好的代码注释风格,我对常用的注释进行了总结。以Doxygen的注释风格为主。/*** @brief 定义一个宏,用于检查整数是否为偶数。*//*** @brief 定义一个颜色类型。*/RED, /**< 红色 */GREEN, /**< 绿色 */BLUE /**< 蓝色 */} Color;/*** @brief 计算两个整数的和。* 这个函数接收两个整数参数,并返回它们的和。* @param a 第一个整数。* @param b 第二个整数。

m0_74238942的博客 934

Doxygen注释风格

全部内容来自http://blog.51cto.com/ticktick/1886741      Doxygen的注释风格1.1   综述在每个代码项中都可以有两类描述, 这两类描述将在文档中格式化在一起: 一种就是brief描述, 另一种就是detailed。 两种都是可选的,但不能同时没有。顾名思义, 简述(brief)就是在一行内简述地描述。而详细描述(detailed descripti...

guoyanbo_81的专栏 2126

Doxygen详细介绍(三)(Doxygen注释风格)

5      Doxygen的注释风格 5.1   综述 在每个代码项中都可以有两类描述, 这两类描述将在文档中格式化在一起: 一种就是brief描述, 另一种就是detailed。 两种都是可选的,但不能同时没有。 顾名思义, 简述(brief)就是在一行内简述地描述。而详细描述(detailed description)则提供更长, 更详细的文档。 Doxygen支持c风格注释、c

LearnboC的博客 1028

[转]基于 Doxygen 的 C++ 注释风格

不错的文章。 http://guqian110.github.io/pages/2015/01/13/doxygen_cpp_comment_style.html https://blog.youkuaiyun.com/czyt1988/article/details/8901191

上帝之手的博客 415

Doxygen的注释风格

Doxygen的注释风格 from: http://ticktick.blog.51cto.com/823160/188674 5.1   综述 在每个代码项中都可以有两类描述, 这两类描述将在文档中格式化在一起: 一种就是brief描述, 另一种就是detailed。 两种都是可选的,但不能同时没有。 顾名思义, 简述(brief)就是在一行内简述地描述。而详细描述(detailed d

一码算一码 1643

Doxygen 的 C/C++注释风格 以及 常用指令

        在注释中加一些Doxygen支持的指令,主要作用是控制输出文档的排版格式,使用这些指令时需要在前面加上“\”或者“@”(JavaDoc风格)符号,告诉Doxygen这些是一些特殊的指令,通过加入这些指令以及配备相应的文字,可以生成更加丰富的文档,下面对比较常用的指令做一下简单介绍。 @file 档案的批注说明。 @author ...

HelloKandy's Blog 4514
上一篇: 5.4 C++风格的注释
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值