整篇用来收集各种常用的doxygen约定注释格式的模板。方便实战时使用,大部分实例来自拷贝网络的实例。
1. 文件注释
/**************************************************************************/
/**
* @brief 对于文件的简单注释
* @details 对于文件的详细注释
* @addtogroup example 范例
* @author Alex.shi
* @version 0.01
* @date 2010/05/25
******************************************************************************
* Copyright (c), 2010, Alex Co., Ltd.
******************************************************************************
* Edit History /n
* -------------------------------------------------------------------------/n
* DATE NAME DESCRIPTION /n
* 2010/05/25 Alex.shi Create./n
******************************************************************************
* @{
*****************************************************************************/
……………… // 源码内容
……………… // 源码内容
/** @}***********************************************************/
modules:
/** \addtogroup <label>
* @{
*/
...
/** @}*/
注意:上面的几处 ”/n” 是必须的,否则显示出来将会把那几行挤到一行中。
2. 函数注释
/**
* 设置日期的显存
* @param[in] beginPos 对应区域开始显示的地址
* @param[in] order order>0: year/month/date;order=0: date/month/year
* @param[in] linkChar 日期间的连接符, 目前仅支持 '*''#''-''_''='
* @param[in] year 1-9999
* @param[in] month 1-12
* @param[in] day 1-31
* @return 操作结果, 见 ERR_LED_E
* @note 只有在调用 LED_Update 后才起效
* @see ::LED_Update ::LED_SetSerialBuf ::LED_SetCharBuf
* @see ::LED_SetTimeBuf ::LED_SetMoneyBuf ::LED_ClearAreaBuf
*/
PUBLIC ERR_LED_E LED_SetDateBuf(uint8 beginPos, uint8 order, uint8 linkChar,
uint16 year, uint8 month, uint8 day)
说明:
@param:注释输入/输出参数;
@return:返回值
@see:参考内容,若 LED_Update() 函数存在的话,将会在文档中显示为 LED_Update的链接。
@note:显示注意事项
3. 普通注释
/** 区域类型 */
typedef enum
{
LED_AREA_NULL = 0, /**< 区域头 */
LED_AREA_SERIAL_NO, /**< 序号区域 */
LED_AREA_TEXT, /**< 文本区域 */
LED_AREA_TIME, /**< 时间区域 */
LED_AREA_MONEY, /**< 金额区域 */
LED_AREA_UNDEFINE /**< 区域尾 */
}LED_AREA_E;
说明:
/** 注释内容 */ :对该注释后面的内容(如枚举类型、变量等)进行注释;
/**< 区域头 */ :对该注释前面的内容(如枚举类型、变量等)进行注释;
4. 块定义
块定义主要是将相关的一些变量、函数等信息统一在一起显示,并给他们取个名字。如底下的例子,将程序涉及到的几种图标用宏定义出来,并放在一起,起名为“各种图标定义”。
/****************************************************************/
/**
* @name 各种图标定义
* @{
*/
/** 锁图标 */
#define LED_ICON_LOCK 0x0001
/** 日图标 */
#define LED_ICON_DAY 0x0002
/** 月图标 */
#define LED_ICON_MONTH 0x0004
……
/** @}各种图标定义**************************************************/
目前用的比较多的也就是这几种注释格式了,以后有碰到其他的再续。
分享到:
相关推荐
doxygen-1.9.2-setup.zip
doxygen安装包
doxygen安装文件和使用方法详述,包含对应的Doxygen注释的语法包含对应的Doxygen注释的语法
doxygen-1.8.0-setup.exe
windows下doxygen-1.8.12帮助文档生成工具
Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、...注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxygen可以从一套归档源文件开始,生成HTML格式的在线类浏览器,或离线的LATEX、RTF参考手册。
用CodeBlocks和插件Doxygen(doxyblocks)定义代码模板并生成帮助文件, 文档格式类似java doc. 具体参看: https://blog.csdn.net/jhsword/article/details/95528823
doxygen-1.8.18-setup.exe, achieved by https://www.doxygen.nl/download.html, please find your own version and download
doxygen-1.8.6-setup.exe doxygen 文档生成
doxygen-1.9.2-setup
qtcreator-doxygen-0.3.9-qtcreator-3.1.x-linux-x86_64.tar.gz qtcreator增加doxygen注释 this is a backup
这是doxygen使用手册,用于规范化注释文档,其支持 C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl, and to some extent D.
三个软件 doxygen-1.9.3-setup.exe htmlhelp.exe graphviz-install-2.50.0
maven-doxygen-plugin-1.0.jar
Doxygen-1.5.7-tiger.dmg
python库。 资源全名:doxygen_junit-2.2.0-py3-none-any.whl
doxygen_manual-1.8.4
doxygen_manual-1.8.2,原版英文资料
doxygen 手册, doxygen 手册
doxygen-1.6.1-6.el6.i686.rpm