1. 模块定义(单独显示一页)
/*
* @defgroup 模块名 模块的说明文字
* @{
*/
… 定义的内容 …
/** @} */ // 模块结尾
2. 分组定义(在一页内分组显示)
/*
* @name 分组说明文字
* @{
*/
… 定义的内容 …
/** @} */
3. 变量、宏定义、类型定义简要说明
/** 简要说明文字 */
#define FLOAT float
/** @brief 简要说明文字(在前面加 @brief 是标准格式) */
#define MIN_UINT 0
/*
* 分行的简要说明 /n
* 这是第二行的简要说明
*/
int b;
4. 函数说明
/*
* 简要的函数说明文字
* @param [in] param1 参数1说明
* @param [out] param2 参数2说明
* @return 返回值说明
*/
int func(int param1, int param2);
/*
* 打开文件 /n
* 文件打开成功后,必须使用 ::CloseFile 函数关闭。
* @param[in] file_name 文件名字符串
* @param[in] file_mode 文件打开模式字符串,可以由以下几个模块组合而成:
* - r 读取
* - w 可写
* - a 添加
* - t 文本模式(不能与 b 联用)
* - b 二进制模式(不能与 t 联用)
* @return 返回文件编号
* - -1 表示打开文件失败
* @note 文件打开成功后,必须使用 ::CloseFile 函数关闭
* @par 示例:
* @code
// 用文本只读方式打开文件
int f = OpenFile(”d://test.txt”, “rt”);
* @endcode
* @see ::ReadFile ::WriteFile ::CloseFile
* @deprecated 由于特殊的原因,这个函数可能会在将来的版本中取消。
*/
int OpenFile(const char* file_name, const char* file_mode);
5. 枚举类型定义
/** 枚举常量 */
typedef enum TDayOfWeek
{
SUN = 0, /**< 星期天(注意,要以 “<” 小于号开头) */
MON = 1, /**< 星期一 */
TUE = 2, /**< 星期二 */
WED = 3, /**< 星期三 */
THU = 4, /**< 星期四 */
FRI = 5, /**< 星期五 */
SAT = 6 /**< 星期六 */
}
/** 定义类型 TEnumDayOfWeek */
TEnumDayOfWeek;
6. 项目符号标记
/*
* A list of events:
* - mouse events
* -# mouse move event
* -# mouse click event/n
* More info about the click event.
* -# mouse double click event
* - keyboard events
* -# key down event
* -# key up event
*
* More text here.
*/
结果为:
A list of events:
mouse events
mouse move event
mouse click event
More info about the click event.
mouse double click event
keyboard events
key down event
key up event
More text here.
代码示范:
/*
* @defgroup EXAMPLES 自动注释文档范例
* @author minidxer
* @version 1.0
* @date 2007-2008
* @{
*/
/*
* @name 文件名常量
* @{
*/
/** 日志文件名 */
#define LOG_FILENAME “c://log//debug.log”
/** 数据文件名 */
#define DATA_FILENAME “c://data//detail.dat”
/** 存档文件名 */
#define BAK_FILENAME “c://data//backup.dat”
/** @}*/ // 文件名常量
/*
* @name 系统状态常量
* @{
*/
/** 正常状态 */
#define SYS_NORMAL 0
/** 故障状态 */
#define SYS_FAULT 1
/** 警告状态 */
#define SYS_WARNNING 2
/** @}*/ // 系统状态常量
/** 枚举常量 */
typedef enum TDayOfWeek
{
SUN = 0, /**< 星期天 */
MON = 1, /**< 星期一 */
TUE = 2, /**< 星期二 */
WED = 3, /**< 星期三 */
THU = 4, /**< 星期四 */
FRI = 5, /**< 星期五 */
SAT = 6 /**< 星期六 */
}
/** 定义类型 TEnumDayOfWeek */
TEnumDayOfWeek;
/** 定义类型 PEnumDayOfWeek */
typedef TEnumDayOfWeek* PEnumDayOfWeek;
/** 定义枚举变量 enum1 */
TEnumDayOfWeek enum1;
/** 定义枚举指针变量 enum2 */
PEnumDayOfWeek p_enum2;
/*
* @defgroup FileUtils 文件操作函数
* @{
*/
/*
* 打开文件 /n
* 文件打开成功后,必须使用 ::CloseFile 函数关闭。
* @param[in] file_name 文件名字符串
* @param[in] file_mode 文件打开模式字符串,可以由以下几个模块组合而成:
* - r 读取
* - w 可写
* - a 添加
* - t 文本模式(不能与 b 联用)
* - b 二进制模式(不能与 t 联用)
* @return 返回文件编号
* - -1 表示打开文件失败
* @note 文件打开成功后,必须使用 ::CloseFile 函数关闭
* @par 示例:
* @code
// 用文本只读方式打开文件
int f = OpenFile(”c://test.txt”, “rt”);
* @endcode
* @see ::ReadFile ::WriteFile ::CloseFile
* @deprecated 由于特殊的原因,这个函数可能会在将来的版本中取消。
*/
int OpenFile(const char* file_name, const char* file_mode);
/*
* 读取文件
* @param[in] file 文件编号,参见:::OpenFile
* @param[out] buffer 用于存放读取的文件内容
* @param[in] len 需要读取的文件长度
* @return 返回读取文件的长度
* - -1 表示读取文件失败
* @pre /e file 变量必须使用 ::OpenFile 返回值
* @pre /e buffer 不能为 NULL
* @see ::OpenFile ::WriteFile ::CloseFile
*/
int ReadFile(int file, char* buffer, int len);
/*
* 写入文件
* @param[in] file 文件编号,参见:::OpenFile
* @param[in] buffer 用于存放将要写入的文件内容
* @param[in] len 需要写入的文件长度
* @return 返回写入的长度
* - -1 表示写入文件失败
* @pre /e file 变量必须使用 ::OpenFile 返回值
* @see ::OpenFile ::ReadFile ::CloseFile
*/
int WriteFile(int file, const char* buffer, int len);
/*
* 关闭文件
* @param file 文件编号,参见:::OpenFile
* @retval 0 为成功
* @retval -1 表示失败
* @see ::OpenFile ::WriteFile ::ReadFile
* @deprecated 由于特殊的原因,这个函数可能会在将来的版本中取消。
*/
int CloseFile(int file);
/** @}*/ // 文件操作函数
/** @}*/ // 自动注释文档范例
文章出处:飞诺网(www.firnow.com):http://dev.firnow.com/course/3_program/vc/vc_js/20090327/163589.html
分享到:
相关推荐
阅读开源代码往往会被复杂的程序调用搞晕,用Doxgen+Graphiz+htmlhelp生成CHM文档对于阅读代码,有很好的帮助。关于软件的配置见:http://blog.csdn.net/fasfewatgerjhytsjy/article/details/41046431
doxygen代码文档生成工具包,包含软件:doxygen1.8.17,、graphviz2.38,htmlhelp三个软件,满足正常使用。
Doxygen和Graphvic的完美结合,让你看代码变的轻松。
Doxygen等工具制作开发文档的详细过程。 Doxygen + Graphviz + Htmlhelp
visualc++开发文档生成工具Doxygen教程参考.pdf
.所有注释都可以使用///开始(C++风格)。 2.类体前必须加上///描述,否则会产生警告【Compound 类名 is not documented】 描述中最好不要带有此类的类名,否则会产生两个链接(但指向同一个文件)影响美观。...
doxygen是一种很强大的生成文档的工具,可以很清楚的帮助我们生成清晰的文档结构,包括类图,关系图,调用关系图,继承图等等
Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言,部分支持...Doxgen可以从一套归档源文件开始,生成HTML格式的在线类浏览器,或离线的LATEX、RTF参考手册。
sourceinsight 便捷插件 符合Doxygen的注释标准
一个关于开发文档自动生成的工具Doxygen的详细说明文档。
现在免费分享啦!!! VS2010、VS2012、VS2013的代码自动注释插件。 安装该插件后,可以在VS的菜单中显示“注释”主菜单,可以给类、函数、成员添加标准的注释,与Doxygen配合使用,可以直接生成项目的注释文档。...
该文档是doxygen生成chm教程,特别是实现了用graphviz生成类图、调用依赖图等,很实用,欢迎下载。
详细介绍Doxygen自动生成文档工具的使用说明:包括注释使用风格介绍,文档提取介绍等。可自动生成html/chm格式的文档。很多开源的工具都使用它提取文档,如KDE,Qt、ACE。
用于Visual Studio的生成Doxgen风格注释的插件
doxygen_manual-1.8.13.pdf doxygen中文手册v1.63.pdf doxygen使用详解.pdf
doxygen+graphviz生成函数调用图的doxgen配置文件,亲测有效
ue4_doxygen_source_filter 这是一个小的脚本,旨在允许文档工具在使用C ++代码上运行。 这是通过过滤C ++代码以查找类似于UE4宏的内容并将其注释掉来完成的,因为注释掉的版本仅传递给了Doxygen,因此不会对您的...
xcode自动化注释工具,输入///后,可以产生doxgen风格的注释
我自己用doxgen 生成的,目前来说最新的版本,如果需要其他版本可以自己生成。
用doxgen从gdal1.10源码中提取的帮助文档,chm格式,有chi索引文件,可以全文检索。