doxygen 支持c/c++/java/python/php等多种语言的提取, 支持html/rtf/latex/xml/man等多种方式的导出,效果比javadoc丰富。
一. 配置文件
#doxygen -g 会在当前目录产生名称为 Doxygen 的默认配置文件,配置文件采用 key = value 这样结构,只需根据需要修改几项即可生成文档。下面几项比较重要:
PROJECT_NAME = "Basic Sytle Test" #工程名称 OUTPUT_DIRECTORY = ./html #文档的生成目录 INPUT = test #要生成文档的源文件目录 EXTRACT_ALL = yes #告诉doxygen,即使函数没有注释,也要提取 EXTRACT_PRIVATE = yes #提取私有成员信息 EXTRACT_STATIC = yes #提取静态成员信息 GENERATE_HTML = YES #导出html
直接在该目录运行 doxygen 命令,会在html目录内生成文档
二. 注释格式
doxygen支持多种注释格式(具体见example),包括QT和java风格的注释方式,个人比较习惯java注释方式
/** *@brief 通信测试类 *@author kettas *@date 2014/12/22 *@warning The program can't be run *@copyright Aotain Public Lisence */ class TcpService { public: /** *@brief 无参构造函数 */ TcpService(); ~TcpService(); public: /** *@brief 新建流式socket *@param port 通信端口 *@return 是否成功,0表成功,1表失败 */ int add_socket(int port); /** An enum type. More details */ enum EType { var1, /**< enum value 1 */ var2 /**< enum value 2 */ }; private: int sock; };
三. 效果
相关推荐
doxygen_manual-1.8.13.pdf doxygen中文手册v1.63.pdf doxygen使用详解.pdf
doxygen使用说明,标准注释说明及快速入门 svn说明
doxygen使用说明及标准注释说明 2. 准备工程 确定source 编写Doxyfile,也可以用UI工具 编写bat (生产html,并且编译chm)
Doxygen使用文档简介,Doxygen使用文档简介,Doxygen使用文档简介,Doxygen使用文档简介,Doxygen使用文档简介Doxygen使用文档简介Doxygen使用文档简介,Doxygen使用文档简介,Doxygen使用文档简介,Doxygen使用文档...
Doxygen使用教程(个人总结).pdfDoxygen使用教程(个人总结).pdf
Doxygen使用教程,自己根据网站所前辈们的资料总结的。希望给大家带来帮助。
Doxygen使用简介,可以自动生成代码文档等,很不错的工具哦
doxygen在vc++项目开发中是比较常用和必备的工具,如gloox等一些开源库的api都是由doxygen自动生成的,该文给出了doxygen的一些基本用法。
基于doxygen1.8.16版本的教程编制,完美支持中文,含界面选项、操作流程说明,包含示例脚本编写,可正常...ZIP无密码,内含三件套:《使用doxygen自动生成中文设计文档.docx》、示例脚本(完全可用)、PDF版详细教程。
非常好用的一个小程序,自动使用Doxygen来编译源码产生软件开发文档,同时自动搜索画图dot工具安装目录,如果找寻不到会提示您安装,自动转换编码来解决由于Doxygen和Microsoft Html Help编码不同导致的问题 ...
Doxygen可以从C,C++, java等源代码中提取消息来生成帮助文档, API资料等
doxygen是一种很强大的生成文档的工具,可以很清楚的帮助我们生成清晰的文档结构,包括类图,关系图,调用关系图,继承图等等
doxygen技术说明:包括安装说明,使用说明,以及规范说明。
适合根据源代码生成相关文档,减轻了说明文档撰写的工作。
doxygen的安装使用说明,如何注释文件,类,变量,函数并生成多种格式的接口文档。
doxygen 是非常方便的代码注释文档生成工具,这里总结了doxygen的使用方法,仅供参考
许多使用 doxygen 的方法: 1)使用 doxygen 生成一个配置文件的模板: doxygen [-s] -g [configName] 如果 configName 是'-'那么 doxygen 将会把结果写到标准输出。 2)使用 doxygen 更新旧的配置文件: ……
该指南简要介绍了doxygen的使用,包括注释部分及可能出现的代码。附有图及相关说明。