Doxygen学习

最近在阅读源码的时候学习了一个神器-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.

  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值