Doxygen的使用示例(C++)
2015-04-20 19:24
183 查看
在项目中用了Doxygen来制作文档,记录备忘。
查了不少文章,主要使用方法及例子参考都是来自以下链接:
http://wenku.baidu.com/link?url=jYVQTEY6-aHB4x1KwfdmTJ7o_TkmscOvY44cqFncfobD54hAhDPotXPESJOLL-lJf8VA0GL_ZaP8D0Q-gwS6SVLnXDZTruthPkthVCHi39a
使用步骤:
一、安装内容
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
View Code
查了不少文章,主要使用方法及例子参考都是来自以下链接:
http://wenku.baidu.com/link?url=jYVQTEY6-aHB4x1KwfdmTJ7o_TkmscOvY44cqFncfobD54hAhDPotXPESJOLL-lJf8VA0GL_ZaP8D0Q-gwS6SVLnXDZTruthPkthVCHi39a
使用步骤:
一、安装内容
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 * * 此文件用于定义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; }
View Code
相关文章推荐
- C++常用字符串处理函数及使用示例
- C++常用字符串处理函数及使用示例
- C++常用字符串处理函数及使用示例
- C++常用字符串处理函数及使用示例(ASCII)
- C++常用字符串处理函数及使用示例
- 使用Autumn框架进行C++依赖注入示例
- .NET基础示例系列之十八:使用C++调用MySql C Api
- C++ qsort example.C++ 快排函数使用示例
- 使用doxygen为C/C++程序生成中文文档(上)
- 使用doxygen为C/C++程序生成中文文档(上)
- Doxygen在C++中的使用.
- C++模板用法:定义、使用 示例
- doxygen 使用简介(C,C++为代码作注释)
- 使用Doxygen为C\C++代码写文档
- C++常用字符串处理函数及使用示例
- 使用doxygen为C/C++程序生成中文文档
- Regexp使用示例(C++代码)
- C++中string型字符串的使用示例
- C++ map 和 list 转换 排序 遍历使用示例
- 使用doxygen为C/C++程序生成中文文档(上)