小胖求学系列之-文档生成利器(上)-smart-doc

最近小胖上课总是挂着黑眼圈，同桌小张问：你昨晚通宵啦？小胖有气无力的说到：最近开发的项目接口文档没写，昨晚补文档补了很久，哎，昨晚只睡了2个小时。小张说：不是有生成文档工具吗，类似swagger2、smart-doc之类的，你咋不用呢。小胖说：swagger2我倒听过，有一些入行门槛，且对业务代码有侵入性，smart-doc没听过，这玩意好用吗？小张说：smart-doc几乎没有入行门槛，我最近一直在用，有没有感觉我最近工作效率变高了。小胖说：对啊，这货有啥魔法吗，可以不需要学习的情况下，帮助你快速生成接口文档。小张嘴角微微一笑说：你还真猜对了，这个工具只需要你的pom.xml里面引入对应的配置，然后main方法执行下样板代码。markdown和html两种常用格式的文档都可以一键生成，但这个也有几个坑需要注意。小胖惊讶的说：还有坑啊，那我还是自己手动去维护接口文档吧。小张说：你别急，听我说完，在决定要不要用，我在验证这个文档的时候，发现了几个坑，但是这些坑老实说不算坑，用它可以帮助我们代码注释写的更规范写。小胖说：好吧，那我也用这个吧，那到底怎么用呢，这个你也贴一下啊。小张说：具体用法你去看官网吧，网址:https://gitee.com/sunyurepository/smart-doc/wikis/Home。你先回去看看，明天在一起讨论下。小胖进去学习了一番，发现果然是个好东西，从此再也不用花大量精力去维护文档，不过爱动脑筋的小胖就在想，这个好东西如果我推荐给别人使用，别人也愿意像我一样前来学习一波，不行，我得想个更好用的办法，让他变得更易用。