apidoc的使用

Posted bky小斯

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了apidoc的使用相关的知识,希望对你有一定的参考价值。

  1)安装node.js: https://nodejs.org/download/
             从0.6.1开始,Node.js在Windows平台上提供了两种安装方式,一是.MSI安装文件,另外还有一个.EXE可执行文件。
  2)下载npm源代码: https://github.com/isaacs/npm/tags
  3)将npm源代码解压到D:\\npmjs目录中
    安装命令:D:\\>cd npmjs
           D:\\npmjs>node cli.js install -gf
  4)安装apidocjs
    安装命令:npm install apidoc -g
       5)安装express:
           npm install express -g //安装最新版express
      npm install express@2.5.0 //安装指定版本express
      npm remove express -g //删除express
  5)生成apidoc文档:
    替换模板:E:\\node.js\\node_modules\\apidoc\\template\\utils\\handlebars_helper.js
            E:\\node.js\\node_modules\\apidoc\\template\\index.html

以上是关于apidoc的使用的主要内容,如果未能解决你的问题,请参考以下文章

laravel中使用apidoc

APIDOC官方文档(翻译版) 使用文档

安装和简单使用apidoc

apidoc的使用

apidoc文档使用方法

快速根据注释生成接口文档网页工具——Apidoc的使用教程