在软件开发中,经常需要编写软件开发文档,以便后续人员可以较快的了解之前的接口、函数、类和结构,这里介绍几款API生成文档。
1、Doxygen
Doxygen 是一种代码文档生成器,利用Doxygen来提取未归档的代码结构。它能依据程序本身的结构,将批注经过处理重新整理成为一个纯粹的参考手册,对于后面利用的程序代码的人而言将会减少许多的负担。
Doxygen跨平台并且支持多种语言,C/C++、Java、Objective-C、Python、IDL、Fortran、 VHDL、 PHP、 C#。可以生成HTML、 XML、 LaTeX等格式。
具体操作可以参考:DoxyGEN 的使用与Graphviz 的使用,强大的Doxygen工具使用手册
2、Swagger
Swagger框架可以通过代码生成在线API,并提供运行示例。支持Scala、Java、Javascript、Ruby、PHP甚至 Actionscript 3。
具体操作参考:Micro Service工具集之Swagger:可测试的样式化API文档