apidoc接口文档的使用

以下介绍的时候接口文档与源代码分离的形式

  1. 文档文件夹结构
    在这里插入图片描述
    由apidoc及source两部分组成,apidoc负责存放接口文档相关文件(其中的index.html即是可用浏览器浏览,带有一定样式的接口文档),source存放apidoc.json文件以及代码式的接口文档内容(即我们真正编辑的文档内容)。
  2. 编写步骤
    2.1.在source中创建apidoc.json文件(配置文件,具体内容请参考官网文档(翻译))
    2.2.在source中创建_apidoc.js文件,此文件为我们编写的接口文档
  3. 生成apiDoc
		apidoc -i source -o apidoc

**PS:**本文档为apidoc超简洁版本,详情可以参考官网文档(翻译)

你可能感兴趣的:(接口文档)