DoxyGen常用语法标记

因为要经常阅读一些源码英文文档,所以今天把一些常用的DoxyGen关键字合集记录下来,以便以后查阅;

同事也可以方便其他有需要的人能够看到;

下面是我个人认为比较常用的标记:
@author          作者
@brief             摘要
@version         版本号
@date             日期
@file                文件名,可以默认为空,DoxyGen会自己加
@class             类名
@param           函数参数
@return           函数返回值描述
@exception      函数抛异常描述
@warning         函数使用中需要注意的地方
@remarks        备注
@see               see also字段
@note             brief下空一行后的内容表示详细描述,但也可以不空行用note表示
@par               开始一个段落,段落名称描述由你自己指定,比如可以写一段示例代码
@code             引用代码段
@endcode        引用代码段结束
@pre               函数前置条件,比如对输入参数的要求
@post             函数后置条件,比如对系统状态的影响或返回参数的结果预期
附带我感觉不太会常用到的其他标记:
@defgroup       模块名
@name            分组名
@{                  模块开始
@}                  模块结束
@deprecated    今后可能将被废弃或已经有替代品的函数
@since             从哪个版本后开始有这个函数的
@todo             被标记的代码会在ToDo列表中出现
@bug              被标记的代码会在Bug列表中出现
@test              被标记的代码会在Test列表中出现
                    一级项目符号
-#                   二级项目符号

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值