项目需要使用Doxygen 产生文档吗?
最近项目组同事用doxygen对项目的代码生成了对应的文档, 试用了之下还是挺震撼的,特别是对软件项目中后期的重构,为什么这么说呢?
1) 重构一般是代码有混乱的时候,这个时候我们会提出一个新的目标,以及相关的设计方案;
2) 按照新的方案进行重构;
3) 对重构后的系统进行测试,保证原先功能的正确性;
4) 将重构后的系统分享给团队人员,形成新的使用规范,严格执行。
5) 验证重构后的系统是否符合最初的预期;
doxygen 在第三步可以帮助我们找到修改影响的模块,补全测试case; 第四可以让团队迅速了解重构后各模块的使用说明以及API规范。第五步可以让大家看到自己的修改符合预期,产生成就感,进而可以更大胆的进行重构。
别小看doxygen带来的这些,在中国式互联网开发的环境下,文档一直被认为是最有效提高生产力的,但是为了更多的产出功能,团队往往会压缩开发人员review和复盘的时间,导致开发者了解业务当中功能模块往往是通过口口相传。 如果开发者能在写代码的时候关注编码规范(良好的API命名和注释)+ 模块设计,其实这个时候是不需要开发人员去写文档的,根据代码就可以生产一个比较好的文档。
最后doxygen至少一个工具,其本质是团队的软件功能能力, 只有良好的设计+ 执行力,doxygen产生的文档才会有指导性,否则只会是另外一个Chaos系统。