如何创建文件夹

showdoc如何创建⽂件夹_showDoc⽣成⽂档

1.创建项⽬

2.获取api_key和api_token

1.打开设置

2.获取api_key和token

3.⽣成⽂档

1.先cd进⼊你的项⽬⽬录，命令⾏模式下输⼊：

下载完毕，编辑

vishowdoc_

保存⽂件后。执⾏以下命令，脚本会⾃动递归扫描本⽬录和⼦⽬录的所有⽂本代码⽂件，并⽣成API⽂档。

chmod+xshowdoc_

./showdoc_

3.⽂档注释规范

想要⽣成⽂档，需要按照规范进⾏注释：

⽰例：

/**

*showdoc

*@catalog测试⽂档/⽤户相关

*@title⽤户登录

*@description⽤户登录的接⼝

*@methodget

*@headertoken可选string设备token

*@paramurname必选string⽤户名

*@parampassword必选string密码

*@paramname可选string⽤户昵称

*@return{"error_code":0,"data":{"uid":"1","urname":"12154545","name":"吴系

挂","groupid":2,"reg_time":"1436864169","last_login_time":"0"}}

*@return_paramgroupidint⽤户组id

*@return_paramnamestring⽤户昵称

*@remark这⾥是备注信息

*@number99

*/

以上⽰例显⽰效果如下：

关键字

关键字

说明

@catalog

⽣成⽂档要放到哪个⽬录。如果只是⼆级⽬录，则直接写⽬录名字。如果是三级⽬录，⽽需要写⼆级⽬录/三级⽬录，即⽤/隔开。如”⼀

层/⼆层/三层”

@title

表⽰⽣成的⽂档标题

@description

是⽂档内容中对接⼝的描述信息

@method

接⼝请求⽅式。⼀般是get或者post

@url

接⼝URL。不要在URL中使⽤&符号来传递参数。传递参数请写在参数表格中

@header

可选。header说明。⼀⾏注释对应着表格的⼀⾏。⽤空格或者tab符号来隔开每⼀列信息。

@param

参数表格说明。⼀⾏注释对应着表格的⼀⾏。⽤空格或者tab符号来隔开每⼀列信息。

@json_param

可选。当请求参数是json的时候，可增加此标签。请把json内容压缩在同⼀⾏内。

@return

返回内容。请把返回内容压缩在同⼀⾏内。如果是json，程序会⾃动进⾏格式化展⽰。如果是⾮json内容，则原样展⽰。

@return_param

返回参数的表格说明。⼀⾏注释对应着表格的⼀⾏。⽤空格或者tab符号来隔开每⼀列信息。

@remark

备注信息

@number

可选。⽂档的序号。