apiDOC安装和使用

安装

安装Node.js:
点击此链接 https://nodejs.org/en/download/下载安装
安装apiDOC:
$ npm install apidoc -g	# 安装前必须先安装npm,npm包管理工具随同Node.js安装

使用

配置文件:
apidoc.json控制着整个模版内容相关结构
基本操作:
请查看 apiDOC官网!!!

执行

终端执行:
# myapp指向apidoc.json所在路径
# apidoc指向生成doc文件所在路径
# mytemplate指向api文档采用模版路径,默认为官方模版
$ apidoc -i myapp/ -o apidoc/ -t mytemplate/

你可能感兴趣的:(API)