Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言,部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以从一套归档源文件开始,生成HTML格式的在线类浏览器,或离线的LATEX、RTF参考手册。

简介:

Doxygen 是一个程序的文件产生工具,可将程序中的特定批注转换成为说明文件。通常我们在写程序时,或多或少都会写上批注,但是对于其它人而言,要直接探索程序里的批注,与打捞泰坦尼克号同样的辛苦。大部分有用的批注都是属于针对函数、类型等等的说明。所以,如果能依据程序本身的结构,将批注经过处理重新整理成为一个纯粹的参考手册,对于后面利用您的程序代码的人而言将会减少许多的负担。不过,反过来说,整理文件的工作对于您来说,就是沉重的负担。
对于未归档的源文件,也可以通过配置Doxygen来提取代码结构。或者借助自动生成的包含依赖图(includedependency graphs)、继承图(inheritance diagram)以及协作图(collaborationdiagram)来可视化文档之间的关系。Doxygen生成的帮助文档的格式可以是CHM、RTF、PostScript、PDF、HTML和Unixman page等。
一个好的程序设计师,在写程序时,都会在适当的地方加上合适的批注。如果,能够在撰写批注时,稍微符合某种格式,接着就可以透过一个工具程序依据程序结构及您的批注产生出漂亮的文件。这将令许多工作繁重的程序设计师有时间多喝几杯咖啡。
Doxygen 就是这样的一个工具。在您写批注时,稍微按照一些它所制订的规则。接着,他就可以帮您产生出漂亮的文件了。因此,Doxygen 的使用可分为两大部分。首先是特定格式的批注撰写,第二便是利用Doxygen的工具来产生文件。

Doxygen 一个程序的文件产生工具,可将程序中的特定批注转换成为说明文件相关推荐

  1. mpvue两小时,产出一个《点钞辅助工具》小程序

    代码地址如下: http://www.demodashi.com/demo/13564.html CoffeeScript,Pug,Sass使用 以下内容门槛较高,如看不懂或觉得需要继续了解,请前往官 ...

  2. 微信小程序:娱乐小工具微信小程序源码下载支持多种流量主

    这应该是属于娱乐小工具呢还是属于工具箱类型就看你们怎么分辨了 当然啦说是娱乐也可以,里面功能应该也属于娱乐性 如果说是工具类型也可以,里面也属于工具吧 该程序由几个小功能组合而成如有: 网易云音乐下载 ...

  3. linux进入文件夹命令,如何在 Linux 中不使用 CD 命令进入目录/文件夹?

    众所周知,如果没有 cd 命令,我们无法 Linux 中切换目录.这个没错,但我们有一个名为 shopt 的 Linux 内置命令能帮助我们解决这个问题. shopt 是一个 shell 内置命令,用 ...

  4. linux git删除的文件怎么还原,从Git仓库中恢复已删除的分支、文件或丢失的commit...

    从Git仓库中恢复已删除的分支.文件或丢失的commit 在使用Git的过程中,有时可能会有一些误操作 比如:执行checkout -f 或 reset -hard 或 branch -d删除一个分支 ...

  5. java代码将excel文件中的内容列表转换成JS文件输出

    思路分析 我们想要把excel文件中的内容转为其他形式的文件输出,肯定需要分两步走: 1.把excel文件中的内容读出来: 2.将内容写到新的文件中. 举例 一张excel表中有一个表格: 我们需要将 ...

  6. java怎么清空一个文件内容_如何从文本文件中删除特定内容? - java

    我正在Java的SO的帮助下从事此项目的工作,正在读取一个文件夹,然后将其内容写入文件.然后,我需要浏览该内容,仅保留末尾带有Thumbnail.jpg的图像. 编辑: public static f ...

  7. 小程序源码提取工具_小程序一款高效的视频声音提取和识别工具!

    编注:小程序系列面向正在使用Android.iOS.iPad OS.PC.Mac平台设备的朋友.无需单独下载App,在微信中直接打开就可以使用,即用即走,帮你更高效的完成一些事情! 给大家推荐一款高效 ...

  8. 车险计算器微信小程序源代码下载【工具型小程序】

    简单的计算让你知道车险的价值 前两天,一个小伙伴私信我,说想找一个车险计算器的小程序源代码. 然后小二特别注意它,发现这个 还用了一个简单的源代码,所以边肖把它发给了大家. 知道如何具体介绍它,所以让 ...

  9. C# : 操作Word文件的API - (将C# source中的xml注释转换成word文档)

    这篇博客将要讨论的是关于: 如何从C#的source以及注释, 生成一份Word格式的关于各个类,函数以及成员变量的说明文档. 他的大背景如下...... 最近的一个项目使用C#, 分N个模块, 在项 ...

最新文章

  1. sas table将缺失值计入百分比_SAS:通过数据块填充缺失值
  2. [转]Intellij idea创建javaWeb以及Servlet简单实现
  3. Hive与Hadoop的调用关系
  4. sqlserver的for xml path和mysql的group_concat的区别
  5. 关于C++标准库中的数据抽象
  6. Word转PDF表格边框横线丢失
  7. 小米9 -MIUI12.5稳定版卡刷包与线刷包-V12.5.3.0.RFACNXM
  8. matlab积分超过最大值,MATLAB 定积分上限是变量a,如何求解目标函数关于变量a的最大值?谢谢...
  9. 厉害了!百度智能云NIRO Pro智能机器人半年内连获三项产品设计大奖
  10. Atitit 圣阿提拉克斯阿克巴仁波切诗歌集 1. 诗歌集分类 1 1.1. 国王颂歌 1 1.2. 爱情类(相逢 赞美 相识 思念 离去 分分离离 忘记) 1 1.3. 其他 1 1.4. 大
  11. 【活动】VUCA时代下的项目管理:京东技术+系列论坛
  12. 中国计量大学现代科技学院第四届“中竞杯”程序设计校赛(同步赛)F.爬塔
  13. Definition of Dichotomy
  14. 会计基础-会计账簿+对账+结账+财产清查+财务会计报告+会计核算程序
  15. 截部分陈宏对用线段树解矩形并的轮廓(picture 问题的深入讨论)
  16. [ZJOI2009]狼和羊的故事【网络流】【最大流(最小割)】
  17. 2023年网络安全比赛--Web综合渗透测试中职组(超详细)
  18. Android MVP(三)内存泄漏分析与动态代理
  19. masm5.0的使用介绍
  20. Visual Studio for Nintendo Switch? -FUZE4 Nintendo Switch是一个了不起的编码应用程序

热门文章

  1. 从0糖到0防腐剂,元气森林缘何偏向“虎山行”?
  2. 计算机网络——Packet Trace路由器配置——课程设计
  3. 网贷7000元要还36万:年轻人,请你赶紧扔掉这四样东西
  4. CF1567C Carrying Conundrum(组合计数+思维)
  5. trac mysql_无法加载MySQL的Python绑定 – Trac
  6. Linux man page命令后的数字含义
  7. HTTPS背后的加密算法
  8. 协同学:大自然构造的奥秘--哈肯-2
  9. 如何导入BurpSuite 证书
  10. 按键精灵---句柄的介绍及获取