zoukankan      html  css  js  c++  java
  • vs开发nodejs api文档生成神器-apidoc

    直接生成文档的神器 apidoc

    1 win+R 输入 cmd 回车 然后进入 nodejs 项目目录

    例如 D:NodeTest ewApp1

    2  用npm安装 apidoc

    直接输入 npm install apidoc -g  按回车

    3 打开项目的 package.json文件

    加入 "apidoc": { "title": "apiDoc在浏览器中的标题", "url" : "https://api.github.com/v1" }

    4 给接口添加注释

    例如 

    /**
    * @api {post} /api/User/register 用户注册
    * @apiDescription 用户注册
    * @apiName Register
    * @apiGroup User
    * @apiParam {string} name 用户名
    * @apiParam {string} password 密码
    * @apiVersion 1.0.0
    */

    5 生成 apidoc

    输入 apidoc -i api/ -o apidoc/ 

    如果 提示 error: Can not read: package.json, please check the format (e.g. missing comma).

    说明package.json文件格式不正确,或者编码不对,需要改为utf8 无签名 即可

    如果提示 info: Done. 说明生成成功,

    打开项目文件夹 会发现生成新目录apidoc,双击打开里面的index.html 即可。

    官方地址 http://apidocjs.com/

    参考 http://blog.csdn.net/soslinken/article/details/50468896

  • 相关阅读:
    删除指定日期的文件
    pytorch加载数据集
    pytorch ResNet
    pytorch GoogLeNet
    pytorch实现VGG
    pytorch训练AlexNet
    序列化.Net对象到JSON
    c#对象序列化 用来保存对象数据
    Wpf设置listview样式
    wpf listview添加自增序号
  • 原文地址:https://www.cnblogs.com/simadi/p/7009807.html
Copyright © 2011-2022 走看看