apidoc&servicedoc实践
apidoc 下面内容以项目insurance-2a-broker为例 项目根目录增加文件 .gitlab-ci.yml,提交代码时触发Jenkins任务 trigger_build_doc:
stage: deploy
only:
- develop
script:
- curl [阅读全文]
dubbo接口文档生成工具servicedoc
servicedoc是一个开源的文档生成工具,主要用在dubbo接口、远程调用等方面。
servicedoc定义了一套注释规范,按照规范书写注释,然后执行生成用户友好的文档。
注释标记定义如下:
@service
@serviceAuthor
@serviceVersion
@serviceDescription
@serviceGroup
@ser [阅读全文]