通过程序注释生成软件文档,这样做理由如下:1、不用单独维护软件文档
2、文档和程序可以实时同步
3、减小工程师工作量
4、提高工作效率
5、......
废话不多说了,先上一个用Doxygen自动生成的一个程序文档
![]()
led.chm(483.29 KB, 下载次数: 16)2012-7-6 17:13 上传点击文件名下载附件
再上传这个文档的工程源码(STM32的LED灯闪烁)
![]()
gpio_led.rar(631.49 KB, 下载次数: 11)2012-7-6 17:13 上传点击文件名下载附件
说明:源码中可以同步SVN最后更新日期、作者、版本号,所有工作一次性完成,以后每次CI的时候都会自动更新。