标签：
在项目中用了Doxygen来制作文档，记录备忘。
查了不少文章，主要使用方法及例子参考都是来自以下链接：
使用步骤：
一、安装内容
1 安装 Doxygen(Windows)
2 安装 graphviz(Windows)
因为项目比较小所以没有安装graphviz
3 安装 Windows Help Workshop
要生成 CHM 格式的文档需安装
二、配置Doxygen
1 写的代码注释很多都是中文的，如果源码是GB2312格式，记得转为UTF-8格式。直接输入GB2312格式没有尝试。
2 Export Label 下的HTML选项中，CHM_INDEX_ENCODING选项要使用GB2312，否则生成的CHM中会显示乱码。（实际上在使用CHM中的搜索功能时仍存在乱码，未解决）
3 记住要添加 hhc.exe 的路径。
三、代码示例
此示例在链接示例基础上修改，简单的注释变量、函数、类等基本够用了。注释应该还有一些其他的功能，有时间需要深入了解一下。PS:例如想插入一些调用函数的示例代码。
.h
/** * @file * * 此文件用于定义class example * *@auther ... */ ///定义EXAMPLE_OK的宏为0 #define EXAMPLE_OK 0 /** * @brief 类的简短说明 * * 此类用于doxygen的使用说明 * */ class Example { private: /// 变量var1 int var1; public: /// 变量var2 int var2; /// 变量var3 int var3; void ExFunc1(void); void int ExFunc2(int a,char b); char *ExFunc3(char *c); }
.cpp
/** * @file * * 此文件用于定义example class 的 * member function * * @author ... */ /** * @brief ExFunc1 的简易说明 * * ExFunc1没有任何参数及返回值 */ void Example::ExFunc1(void) { //code } /** * @brief ExFunc2 的简易说明 * * ExFunc2()传回两个参数相加的值 * * @param a 用来相加的参数 * @param b 用来相加的参数 * @return 传回两个参数相加的结果 */ int Example::ExFunc2(int a,int b) { return(a+b); } /** * @brief ExFunc3的简易说明 * * ExFunc3()只传回参数输入的指标。 * * @param c 传进的字符指针。 * @retval NULL 空字符串。 * @retval !NULL 非空字符串。 */ char * Example::ExFunc3(char *c) { return c; }
标签：
原文地址：http://www.cnblogs.com/nightcatcher/p/4441923.html
