没有文档,需要看代码研究各种参数的功能和逻辑,耗时耗力,而让团队共同维护和及时更新文档也不是一件容易的事,想了解下各个公司都是怎么管理的。
1. 有哪些工具比较合适,比如 wiki ?
2. 根据代码注释自动生成是否更加高效和便捷?
1. 有哪些工具比较合适,比如 wiki ?
2. 根据代码注释自动生成是否更加高效和便捷?
1
ChenSir Nov 21, 2016
我们公司用的 wiki ,感觉这种方式还不错。但是,也要求文档别写得太水。
|
2
tabris17 Nov 21, 2016
Confluence
|
3
cnnbboy Nov 21, 2016
|
4
Ouyangan Nov 21, 2016
自己项目在用这个 , 非常友好方便 , http://swagger.io/
公司....老接口口头相传 , 新接口 md 文档 |
5
briclin Sep 15, 2018 via Android
swagger 貌似挺好
|