打印

软件工程师必学技巧——软件文档自动化管理

[复制链接]
1492|0
手机看帖
扫描二维码
随时随地手机跟帖
跳转到指定楼层
楼主
beyond696|  楼主 | 2012-7-6 17:13 | 只看该作者 回帖奖励 |倒序浏览 |阅读模式
本帖最后由 beyond696 于 2012-7-6 17:25 编辑

通过程序注释生成软件文档,这样做理由如下:1、不用单独维护软件文档
2、文档和程序可以实时同步
3、减小工程师工作量
4、提高工作效率
5、......
废话不多说了,先上一个用Doxygen自动生成的一个程序文档
led.chm (483.29 KB)

再上传这个文档的工程源码(STM32的LED灯闪烁)
gpio_led.rar (631.49 KB)

说明:源码中可以同步SVN最后更新日期、作者、版本号,所有工作一次性完成,以后每次CI的时候都会自动更新。

相关帖子

发新帖 我要提问
您需要登录后才可以回帖 登录 | 注册

本版积分规则

个人签名:USB转I2C,SPI,CAN,UART,GPIO,PWM,IR,ADC,DAC合一 http://usb2xxx.taobao.com

55

主题

294

帖子

12

粉丝