工作中一个公司会有很多个项目,项目之间的交互经常需要编写 API 来实现,但是编写文档是一件繁琐耗时的工作,并且随着 API 的迭代,每次都需要去更新维护接口文档,很多时候由于忘记或者人员交替的愿意造成接口文档与代码不一致. 在实际工作中,有的公司会有强制的代码规范,要求代码必须要有注释以及字段.方法.类.接口等的命名规范.但是很多小公司是不存在的,即使按照了规范编写代码也还是需要额外去维护一个文档(word.Excel.markdown等方式),用来提供给其他系统或前端的调用,非常耗时. 那么