项目文档规范

记得大学有一门课程就叫做的软件文档编写，当然我已经记不清楚了，其中的内容了，就实际而言，谈谈其中的使用吧，
最基本的就是办公软件了，我比较喜欢的excel的但是也是无奈之举了。（没有生产力，非必要不适用）。
最好的方式是使用工具了，
集成工具：
IEDA javadoc 生成java 工具。
辅助工具：dotxy,postman 等工具。
专业工具：swagger,knife4j
如下分别介绍：

基本

最好使用模版模式处理填充即可，没啥生产力

java doc

后端代码，集成在ＩＥＤＡ中。

doxygen

专业一般不常用

postman

收费的，可以导出json

swagger

用来显示API文档的，不可编辑，会根据我们在代码中的设置来自动生成Api说明文档。

knife4j:

对比下Swagger，看看使用knife4j和它有啥不同之处

1、 返回结果集支持折叠，方便查看

2、 请求参数有JSON校验功能

3、 knife4j支持导出离线文档，方便发送给别人，支持Markdown格式

直接选择文档管理->离线文档功能，然后选择下载Markdown即可

4、忽略参数属性

推崇的是代码即文档，写了代码就写了文档。提高生产力。

5.我在开发的过程中发现没有中文含义的，前端很难知道该对照哪个数值，这边最好还是写注释吧，
用工具生成文档吧。上述几个工具交换使用吧。

推荐阅读:

1.（https://blog.csdn.net/yanzhenjingfan/article/details/110467945）