smart-doc详细完整使用教程

本教程使用IDEA+官方示例生成文档的过程,目的是知道这个smart-doc怎样生成文档,然后再根据自己的需要进行调整接口注释。

一、对学习smart-doc有用的网址

1、官方参考文档:Document (smart-doc-group.github.io)

 2、smart-doc源码:smart-doc: smart-doc是一款同时支持java restful api和apache dubbo rpc接口文档生成的工具。完全基于注释生成文档,做到零侵入。 (gitee.com)

3、smart-doc官方示例:smart-doc-example-cn: smart-doc demo,仅为github的同步仓库,pr请前往github (gitee.com)

 二、下载并导入smart-doc官方示例

下载后会发现该项目使用的是JAVA17,用JAVA8不行,JAVA21也是不行,必须要用JAVA17

如果没有JAVA17 ,到官方下载一个免安装的,也不需要配置环境变量,引入到IDEA即可。

JAVA17官方下载

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值