代码说明书制作神器-Doxygen

好玩的MATLAB

点击上方「嵌入式实验基地」，选择「置顶公众号」第一时间查看嵌入式笔记！
摘要 众所周知读代码比写代码难，读没有注释说明的代码是难上加难...既然这个问题这么难，那今天介绍一个程序员都在用的代码说明书制作神器-Doxygen+Graphviz+html help workshop...
文章摘自知乎：https://zhuanlan.zhihu.com/p/100223113
说说Doxygen、Graphviz、html help workshop DoxygenDoxygen能将程序中的特定批注转换成为说明文件。它可以依据程序本身的结构，将程序中按规范注释的批注经过处理生成一个纯粹的参考手册，通过提取代码结构或借助自动生成的包含依赖图（include dependency graphs）、继承图（inheritance diagram）以及协作图（collaboration diagram）来可视化文档之间的关系， Doxygen生成的帮助文档的格式可以是CHM、RTF、PostScript、PDF、HTML等。
graphvizGraphviz(Graph Visualization Software)是一个由AT&T实验室启动的开源工具包,用于绘制DOT语言脚本描述的图形。要使用Doxygen生成依赖图、继承图以及协作图，必须先安装graphviz软件。
HTML Help WorkShop微软出品的HTML Help WorkShop是制作CHM文件的最佳工具，它能将HTML文件编译生成CHM文档。Doxygen软件默认生成HTML文件或Latex文件，我们要通过HTML生成CHM文档，需要先安装HTML Help WorkShop软件，并在Doxygen中进行关联
见示例效果图。