本文参考博客:https://www.jianshu.com/p/9353d5cc1ef8
apidoc是一款可以有源代码中的注释直接自动生成api接口文档的工具,它几乎支持目前主流的所有风格的注释。例如:Javadoc风格注释(可以在C#, Go, Dart, Java, JavaScript, PHP, TypeScript等语言中使用)
本文只讲述 APIDOC 的基本用法!!!!
环境:win7
首先需要使用 npm 安装 apidoc(前提是安装了node.js,请自行安装), 在DOC中输入以下命令
npm install apidoc -g
apidoc的使用很简单,只是通过一些简单的注释 来生成API文档,这里直接上例子
百度网盘: https://pan.baidu.com/s/1OdCGvdNMQuePfpzmkbrZog 提取码: 6gs7
CSDN: https://download.csdn.net/download/zcf980/10948648 (抱歉!!下载积分无法自定义,喜欢的可以支持)
模板使用方法:下载模板并解压,共两个文件,一个配置文件apidoc.json和一个需要生成 API 的 .java 文件
在DOC中输入以下命令
apidoc -i D:\apidocDemo -o D:\api
其中 -i 为输入路径, 即需要生成API的文件所在位置, -o 输出路径,即生成API文档保存的位置
执行命令后即生成了 API 文档