1.在源文件中添加Doxygen格式的源码注释
1.1分步指南
- 文件注释
放于文件的开头,例如:
/** * @file filename * @brief This is a brief description. * @details This is the detail description. * @author author * @date date * @version A001 * @par Copyright (c): * XXX公司 * @par History: * version: author, date, desc\n */
-
函数注释
放于函数声明前,例如:
/** 下面是一个含有两个参数的函数的注释说明(简述) * * 这里写该函数的详述信息 * @param [in] a 被测试的变量 【参数描述1】 * @param [in] s 指向描述测试信息的字符串 【参数描述2】 * @return 测试结果 (return描述返回值) * @see Test() (本函数参考其它的相关的函数,这里作一个链接) * @note (note描述需要注意的问题) */ int testMe(int a,const char *s);
-
数据结构注释
应放于函数声明前,例如:
/** * The brief description. * The detail description. */ typedef struct { int var1;///<Description of the member variable }XXXX; 或者 typedef struct box { 成员变量注释(enum的各个值也如此注释): double length; ///< The length of the box double width; ///< The width of the box double height; ///< The height of the box };
-
宏定义注释
放于宏定义上方或者右侧,例如:
/** Description of the macro */ #define XXXX_XXX_XX ox7fffffff 或者 #define XXXX_XXX_XX 0 ///< Description of the macro.
-
全局和静态变量注释
/** Description of global variable */ int g_xxx = 0; static int s_xxx = 0; ///< Description of static variable
2.使用Doxygen工具,为添加了Doxygen格式注释的源码自动生成接口说明文档
2.1分步指南
- 参照Doxygen源码注释规范,为源码添加注释
- 安装Doxygen,如希望生成pdf格式说明,还需要安装支持latex格式解析的工具软件如MikTex
- 运行Doxygen安装目录下的doxywizard,配置参数(输出latex,如果希望生成pdf版本)
Mode → All Entities
Output → HTML/Latex(for pdf) - 如需输出版本号,运行Doxygen,在Project的Project version or id处输入版本号即可
-
在Run页面,选择Run doxygen,生成Doxygen配置文件及相应输出
如果要生成pdf版本:对于中文注释或文档,需要先修改生成的latex\refman.tex写道1. 将
\begin{document}
替换为
\usepackage{CJKutf8}
\begin{document}
\begin{CJK}{UTF8}{gbsn}
2. 将
\end{document}
替换为
\end{CJK}
\end{document}
3. 删除无用章节
\chapter{使用说明}
\label{md__r_e_a_d_m_e}
\Hypertarget{md__r_e_a_d_m_e}
\input{md__r_e_a_d_m_e} -
如需添加日期、文档制作者信息,则修改以下内容
写道1.文档页脚的制作者信息:修改"制作者"后的信息
\fancyfoot[RE]{\fancyplain{}{\bfseries\scriptsize 制作者 XXX }}
\fancyfoot[LO]{\fancyplain{}{\bfseries\scriptsize 制作者 XXX }}
2.添加信息:
Large后为输入项,可自行输入显示的文本
[lex]为换行标识,会自动换行显示
\begin{center}%
{\Large xxx接口文档 \\[1ex]\large version XXX }\\
\vspace*{1cm}
{\large 2017.7.20}\\ -
在生成的latex目录下运行make,编译生成pdf说明文件
相关推荐
通过启动Doxygen注释块并按Enter,此VS Code扩展可以即时生成Doxygen文档。 目录 产品特点 对准 有关其工作原理,请参见 属性 析构函数 广泛的定制 档案说明 功能指针 经营者 参量 退货类型 智能文字 支持的智能...
Doxygen 文档生成 跨语言 按照良好的代码注释规则 文档轻松可见。
doxygen文档生成工具
VC 6 文档生成工具:doxgen 能生成漂亮的技术文档的工具,以后再也不用为写技术文档发愁了。
详细介绍doxygen各种注释标准、方法,并生成chm的过程
doxygen 1.61 十分好用的文档自动生成工具,尤其适合生成api手册。 示例、chm自动编译插件打包。关系图生成插件graphviz放在另外的链接提供下载,链接为http://download.csdn.net/source/2143324
根据V8.h用Doxygen生成的文档,包含两个例子代码,只为方便查询。
用doxygen+graphviz自动化生成代码文档,相关博文:http://www.cnblogs.com/tianzhijiexian/p/4392924.html
该模块是Doxygen的包装,可自动安装和生成doxygen文档,以便可以轻松地将其包含在任何项目构建中。 支持Linux,Windows和MacOS。 它支持本地和全局安装。 如果是linux,则可能需要安装clang(版本因所选择的doxygen...
doxygen帮助文档生成工具,c++、java可以使用相同注释规范,然后生成帮助文档
windows下使用doxygen为C C++程序生成中文文档 1.html文件讲解怎么使用 2.需要的一些工具 3.所需要的批处理文件 步骤: 1.阅读 使用doxygen为C/C++程序生成中文文档html文件 2.安装doxygen.rar,graphviz.rar ...
可以按照doxygen规定的格式编写代码注释,然后利用doxygen工具直接生成参考文档
Doxygen, 大名鼎鼎的文档生成工具,被Boost、OpenCasCade等诸多项目作为文档生成的不二人选。
传输错误,请勿下载,请点击其他链接。
opencv 的类文档,当你发现一个类在官网没有文档时,但却在源码中遇见,比如cvblob,百度可以搜到,但opencv的文档一般搜到。这时用Doxygen-gui自动生成opencv的类文档。
Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言,部分支持PHP、C#。...首先是特定格式的批注撰写,第二便是利用Doxygen的工具来产生文档。
Doxygen是一种很强大的转换生成文档的语言工具。