前言:
一般写完代码之后,还要将各类参数注解写入API文档,方便后续进行对接和测试,这个过程通常都很麻烦,如果有工具可以读取代码注释直接生成API文档的话,那会十分方便。
此前一直都是在使用eolinker的,但自从去年他们家“注释生成文档”的功能下线后,我就一直活在水深火热当中——真的不想写文档啊,真的好累啊。
然而这两天上线后,突然发现这个功能重新上线了!必须给大家安利一波!
官网地址:https://www.eolinker.com
根据官方的解释,这个功能简单来说就是读取 gitlab(以前应该还能读本地代码) 的 php 代码(截至发文增加支持读取java,更方便了)注释生成 API 文档。
下面是官方的操作介绍:
1.先在EOLINKER新建项目,随后进入项目概况页,可以在概况页中找到“扫描代码注解生成文档”模块。
2.在同步之前我们打开设置看下需要填写什么信息。
总共是10个选项,我们来分别看下需要怎么填写:
- 1.代