Smart-doc教程（Swagger的无侵入式替代方案）

Smart-doc教程

一、基础入门：

• 首先第一个要推荐的绝对是官方wiki文档，因为smart-doc的更新速度很快，网上的教程或者介绍大多是2.0版本之前的，而且因为比较新这个工具，所以资源也比较少，因此以下的学习分享基本上都来自文档和官方QQ群大佬的指导。

• 官方Gitee wiki

---

二、开始使用

1. 使用前需要了解一下javadoc的一个基本写法

 /**
     * 重置工程下指定用户的所有节点状态
     * @param projectId 小程序用户OpenId
     * @param openId 要重置打卡状态的工程Id
     * @return
     * @throws IOException
     */

• 基本写法就长这样
• 第一行表示对改方法的一个介绍
• @param则是传入参数的一个解释说明
• @return 则是返回值的说明不过一般来说可以不用写
• @throws 则是抛出的异常
<