常用的两款代码文档生成器

在软件开发中,经常需要编写软件开发文档,以便后续人员可以较快的了解之前的接口、函数、类和结构,这里介绍几款API生成文档。

1、Doxygen

Doxygen 是一种代码文档生成器,利用Doxygen来提取未归档的代码结构。它能依据程序本身的结构,将批注经过处理重新整理成为一个纯粹的参考手册,对于后面利用的程序代码的人而言将会减少许多的负担。

Doxygen跨平台并且支持多种语言,C/C++、Java、Objective-C、Python、IDL、Fortran、 VHDL、 PHP、 C#。可以生成HTML、 XML、 LaTeX等格式。
具体操作可以参考:DoxyGEN 的使用与Graphviz 的使用强大的Doxygen工具使用手册

Doxygen界面

2、Swagger

Swagger框架可以通过代码生成在线API,并提供运行示例。支持Scala、Java、Javascript、Ruby、PHP甚至 Actionscript 3。
具体操作参考:Micro Service工具集之Swagger:可测试的样式化API文档

这里写图片描述

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值