我开发的开源文档工具在github上上升到了5300+的star ，受到了部分开发者的欢迎。于是便想写文章与大家分享一下我在整个创作过程中所用到的技术以及相关技能。

如果你是使用官网在线版 showdoc，则下载 app 后直接使用即可。如果你是使用开源版 showdoc （在 github 搜索 showdoc 就可以找到开源地址 )，则需要在登录的时候，在界面右上角指定你部署 showdoc 的服务器地址。请注意确保你的服务器代码已经更新到最新版。

对于写API文档这件事，虽然说文本编辑软件或者接口管理软件能在某种程度上提高我们的效率，但我们依然可以试图借助技术的力量，更自动化地生成API文档，释放自己的生产力。为此，showdoc官方提供了一种自动化解决方案。在代码里编写特定格式的程序注释，然后showdoc通过读取这些注释来自动生成文档。由于这种方式不跟特...