试试使用 eolinker 扫描 GitLab 代码注释自动生成 API 文档?

本文介绍了如何利用EOLINKER工具,通过扫描GitLab上的PHP和Java代码注释自动生成API文档,从而简化文档编写工作。详细步骤包括在EOLINKER创建项目、配置GitLab信息、获取访问令牌,以及理解不同类型的同步更新方式。文章还强调了增量更新的优势和EOLINKER的API历史版本功能。
摘要由CSDN通过智能技术生成
前言:

一般写完代码之后,还要将各类参数注解写入API文档,方便后续进行对接和测试,这个过程通常都很麻烦,如果有工具可以读取代码注释直接生成API文档的话,那会十分方便。
此前一直都是在使用eolinker的,但自从去年他们家“注释生成文档”的功能下线后,我就一直活在水深火热当中——真的不想写文档啊,真的好累啊。
然而这两天上线后,突然发现这个功能重新上线了!必须给大家安利一波!
官网地址:https://www.eolinker.com
根据官方的解释,这个功能简单来说就是读取 gitlab(以前应该还能读本地代码) 的 php 代码(截至发文增加支持读取java,更方便了)注释生成 API 文档。

下面是官方的操作介绍:

1.先在EOLINKER新建项目,随后进入项目概况页,可以在概况页中找到“扫描代码注解生成文档”模块。

图1概况页功能.png

2.在同步之前我们打开设置看下需要填写什么信息。

图2同步需要填写的信息.png

总共是10个选项,我们来分别看下需要怎么填写:

  • 1.代
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值