很多其他产品有过注释生成文档的做法了,但是感觉格式稍微有些复杂,编写不够方便,代码污染
注释格式经过了很长时间的思考,怎样才能更优雅方便?
最终格式如下图,如有不爽的地方,请各位使劲喷:

- 支持所有语言,只要按照上面的规则去添加注释,就可以自动扫描创建成一个易文档的接口文档。
- 缩进必须是对齐的
@easydoc api@end必须配套使用,分别表示开始和结束title表示接口标题。支持多层级目录,用 /分隔每层目录,不存在的目录会自动创建- 参数块当前只支持 3 个,
headersparamsresponse,分别表示请求头参数、请求参数、响应参数,支持子参数,只需要缩进一下。 markdown下面的内容会填入到接口文档的 "说明 / 示例" 区域,使用 markdown 语法mock表示是否自动生成 Mock 接口headersparamsresponsemarkdown这几个支持多行输入,必须换行,并且缩进。- method+url 判断文档是否已存在,存在的更新,不存在则新建
