最近在阅读源码的时候学习了一个神器-Doxygen,安利给大家。顺便放出学习过程中查到的一些好资料。
介绍:Doxygen是为C ++源代码生成文档的的强大工具,但它也支持其他流行的编程语言,如C,Objective-C,C#,PHP,Java,Python,IDL(Corba,Microsoft和UNO / OpenOffice flavor ),Fortran,VHDL,Tcl,部分支持D语言.
Doxygen官网下载安装,与graphviz协作可以生成类图等各种图
筛选了两个中文教程:
Doxygen 10 分钟入门教程
用doxygen+graphviz自动化生成代码文档(附详细教程)
安装完Doxygen和graphviz,并根据源码特性设置config后,就可以为已有的源码生成文档了。简直是看源码的神器。
Doxygen可以根据一定的规范识别注释(文件注释,类注释,函数注释,成员变量注释等等)。这个特性可以直接使程序猿赢得了文档之战的胜利!我们自己在写一些比较大的代码时,可以将注释完善一些,最后一键生成文档!
这个时候需要一个顺手的插件并学习一下Doxygen的注释风格。
强大的sublime test3 DoxyDoxygen插件
基于 Doxygen 的 C++ 注释风格
以上是我的学习经历,分享以备忘。
![Figure 2: Illustration of the All-Reduce collective.](https://i-blog.csdnimg.cn/blog_migrate/d4cf2a7adb2dabbb9f527f2622649d19.jpeg)