文档生产工具 Doxygen
Doxygen是一种开源跨平台的,类似JavaDoc风格描述的文档系统,支持C、C++、Java、Objective-C等语言。可以从一套归档源文件开始,生成HTML,XML,pdf等不同风格的格式。
按照约定的格式注释源代码,用工具处理注释过的源代码产生文档,通过这种方式产生文档,有以下几个好处。
1. 便于代码和文档保持同步
2. 可以对文档做版本管理
使用方法
要使用Doxygen生成文档,主要有两件事
1. 一般用Doxywizard生成Doxyfile后,再手工修改或者通过向导进行修改。建议,一个项目使用单独的Doxyfile配置文件。
2. 按照Doxygen的约定,将代码文档化
3. 执行 doxygen Doxyfile
Doxygen统一采用UTF-8作为输出文件的编码格式。但微软的CHM编译工具(hhc.exe)不支持UTF-8,它支持GB2132
Doxygen的最新版本,可以从Doxygen的网站下载,我使用的是doxygen-1.8.7-setup.exe
Graphviz是一个图形可视化软件。Doxygen使用Graphviz生成各种图形,例如类的继承关系图、合作图,头文件包含关系图等。可以从Graphviz的网站下载Graphviz的最新版本。Doxygen使用了Graphviz的布局引擎dot,所以在文档中将其称作dot。
Mode页面
Output页面:
Diagrams页面:
Expert页面:
我们关心这个页面下的HTML生成选项:
Input页面:
编码相关
Doxygen涉及的东西很多,编码设置很重要,如果设置不当,生成的文档会乱码,因此,需要认真对待。
所有的高级编码设置都在Expert标签下面:
配置文件的格式是unix下通常的文件格式,注释以#开头,tag = value1 [,value2 ].
所有配置,按照功能,分为两类。
一是控制输入选项,控制如何解释源代码,
二是项目相关的信息,比如项目名称、源代码目录、输出文档目录等。
注释风格
头文件模板:
/** @brief 这里写你的摘要
* @file 你的文件名
* @author 谁tmd的搞的
* @version 版本了
* @date 你啥时候搞的
* @note 注解. 例如: 本文件有什么具体功能啊,使用时要注意什么啊…..
* @since 自从 例如: 自从2012年地球爆炸后这个文件就从地球上消失了…..
*/
函数的注释:
/** 这里写这个函数是干什么用的
@param[in] 输入参数1
@param[in] 输入参数2
@param[out] 输出参数1
@return 返回值解释一下
@warning 警告: 例如: 参数不能为空啊,内存要外部释放之类的费话
@note 注解 随便你了
@see 相当于是请参考xxoo函数之类的
*/
变量或者只有一行注解的东东,不超过一行的注释:
/**< 在这里写你要加的东西 */
OR
///< 在这里写你要加的东西
doxygen代码规范使用说明连接: http://blog.csdn.net/augusdi/article/details/6749845
文档生产工具 Doxygen相关推荐
- 源代码文档生成 Doxygen介绍(转载)
源代码文档生成 Doxygen介绍(转载) 收藏 Doxygen介绍 一.Doxygen介绍 在项目开发过程中最重要的是如何和团队中其它成员沟通,如何在项目完成后减低维护成本,随着公司的人员流动,怎样 ...
- java类可视化doxygen_安装doxygen(一个自动文档生成工具)+Graphviz图形可视化软件...
参考文章: 1 Doxygen简介 1.1 What to do? 使用Doxygen生成文档,主要是两件事: 写一个配置文件(Doxyfile),一般用Doxywizard生成后,再手工修改[不建议 ...
- 使用doxygen生成接口api文档
符合doxygen格式的代码注释可以直接通过doxygen命令生成api文档: # doxygen -h Doxygen version 1.8.5 Copyright Dimitri van Hee ...
- javadoc文档的生成方法_Cocoa 代码注释与文档生成
Cocoa 代码注释与文档生成 本文的文档规范部分的内容参考自:NSHipster 的 Swift Documentation 作者 & Nate Cook 本文知识目录 背景 曾经以为好的代 ...
- 强大的代码编档工具—Doxygen
强大的代码编档工具-Doxygen 作者:涩涩 http://blog.csdn.net/sese 本原创文章不经作者许可,不得转载 Doxygen是什么 Doxygen的词根来源于Document( ...
- 技术文档写作的职业探讨
转自 http://blog.csdn.net/u014309159/article/details/44904425 原文链接:http://blog.tianya.cn/blogger/post_ ...
- 利用JapiDocs构建java接口文档(无代码侵入性)
前言 作为一个程序员,最烦恼的就是要写大量的接口文档,业内也有许多的文档生成工具,比如swagger,但是swagger的侵入性很强,需要引入大量的注解,用起来很麻烦.但是现在有个开源的api接口文档 ...
- java自动生成接口文档
java自动生成接口文档 maven依赖 工具类 展示效果 首页 接口页 在平时的开发过程中必定要写接口文档 作为程序员 最烦的2件事 1.别人让你写接口文档 2.接手别人的项目没有接口文档 由此可见 ...
- igh ethercat主站文档(中文翻译上)
此翻译主要是用翻译软件翻译,部分自己修改,若有不当之处,可以下方评论或私聊我提醒修改,若转载,请注明出处 本文是1-4章节. 1 The IgH EtherCAT Master 本章介绍有关Ether ...
最新文章
- CVPR2022最新106篇论文整理|包含目标检测、动作识别、图像处理等32个方向
- 使鼠标保持按住状态_MouseInc 鼠标手势工具
- Linux关闭进程命令
- 我终于知道post和get的区别
- php 输出mysql查询结果_php如何输出mysql查询结果
- if condition 大于_EXCEL中IF函数由浅入深实例分析
- 虚拟机中PXE-MOF:Exiting intel PXE ROM.Operating system not found解决方法
- nodejs模块demo: request-promise-native tough-cookie
- Gdiplus的使用 gdi+
- oracle9i如何卸载,如何卸载oracle 9i
- mac的截图命令screencapture
- 已知三角函数值用计算机如何求角度,【已知三角函数值求角度】第一册已知三角函数值求角...
- Beamer Introduction
- Windows 如何查看主板的型号和厂家,以及支持的最大内存
- python axis到底如何理解?
- 无学历与低学历的看过来!!
- 百度网盘直接下载文件方法
- 香港三电视台千人默哀 无线换节目亚视停广告
- phpcms视频库KU6改为优酷简单上传
- 2020-12-6 CCF201803-2 碰撞的小球