本教程使用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即可。