ShowDoc v2.3.0 发布,可通过程序自动生成API文档

xingchen
 xingchen
发布于 2018年08月19日
收藏 10

ShowDoc v2.3.0 发布了,更新内容:

1、可以通过代码注释自动生成API文档,详情看文档https://www.showdoc.cc/page/741656402509783

 2、优化json格式化功能

 3、fix管理后台的控制台报错

 4、登录页面键盘事件的bug

 5、项目展示页的全屏按钮采用固定定位

 6、页面查看时增加历史版本的入口

  

开源版showdoc请参考手册的升级安装部分进行升级 https://www.showdoc.cc/help?page_id=13732

关于showdoc的介绍,请看:https://www.showdoc.cc/help

本站文章除注明转载外,均为本站原创或编译。欢迎任何形式的转载,但请务必注明出处,尊重他人劳动共创开源社区。
转载请注明:文章转载自 开源中国社区 [http://www.oschina.net]
本文标题:ShowDoc v2.3.0 发布,可通过程序自动生成API文档
加载中

最新评论(2

xingchen
xingchen

引用来自“带头哥哥2018”的评论

给官方提个建议:
调整一下文档关键词的顺序,便于新手理解
  /**
  * showdoc
  * @catalog Admin2018/流程审批
  * @title 启动流程
  * @description workflow相关接口【描述】
  * @method get
  * @url https://www.showdoc.cc/home/user/login
  * @param username 必选 string 用户名
  * @param password 必选 string 密码
  * @param name 可选 string 用户昵称
  * @return {"error_code":0,"data":{"uid":"1","username":"12154545","name":"吴系挂","groupid":2,"reg_time":"1436864169","last_login_time":"0"}}
  * @return_param groupid int 用户组id
  * @return_param name string 用户昵称
  * @remark 这里是备注信息
  * @number 99
  */
已改
带头哥哥2018
带头哥哥2018
给官方提个建议:
调整一下文档关键词的顺序,便于新手理解
  /**
  * showdoc
  * @catalog Admin2018/流程审批
  * @title 启动流程
  * @description workflow相关接口【描述】
  * @method get
  * @url https://www.showdoc.cc/home/user/login
  * @param username 必选 string 用户名
  * @param password 必选 string 密码
  * @param name 可选 string 用户昵称
  * @return {"error_code":0,"data":{"uid":"1","username":"12154545","name":"吴系挂","groupid":2,"reg_time":"1436864169","last_login_time":"0"}}
  * @return_param groupid int 用户组id
  * @return_param name string 用户昵称
  * @remark 这里是备注信息
  * @number 99
  */
返回顶部
顶部