zoukankan      html  css  js  c++  java
  • apidoc,一个相当不错的文档生成器

    例子:
    myapp目录下的MyCode.java

    /**
     *
     * @api {get} /company/list 获取公司信息
     * @apiName 获取公司列表
     * @apiGroup All
     * @apiVersion 0.1.0
     * @apiDescription 接口详细描述
     *
     * @apiParam {int} pageNum分页大小
     *
     * @apiSuccess {String} code 结果码
     * @apiSuccess {String} msg 消息说明
     * @apiSuccess {Object} data 分页数据封装
     * @apiSuccess {int} data.count 总记录数
     * @apiSuccess {Object[]} data.list 分页数据对象数组
     * @apiSuccessExample Success-Response:
     *  HTTP/1.1 200 OK
     * {
     *     code:0,
     *     msg:'success',
     *     data:{}
     *  }
     *
     *  @apiError All 对应<code>id</code>的用户没找到 asdfasdf
     *  @apiErrorExample {json} Error-Response:
     *  HTTP/1.1 404 Not Found
     *  {
     *      code:1,
     *      msg:'user not found',
     *  }
     *
     * @param param
     * @return
     * @throws Exception
     */
    @Deprecated
    public interface MyCode {
        void a();
    }

    生成html文档

    apidoc -i myapp/ -o apidoc/
  • 相关阅读:
    016 vue的组件通信
    015 vue组件中的数据
    014 vue的组件化开发
    013 vue的js中的高阶函数
    012 vue的v-model的使用
    011 vue的购书案例
    010 vue的过滤器的使用
    CF1519F
    CF1519E
    CF1517F
  • 原文地址:https://www.cnblogs.com/ziyouchutuwenwu/p/5662488.html
Copyright © 2011-2022 走看看