首页 > 其他 > 详细

Qt的自文档化工具qdoc

时间:2015-04-08 15:07:26      阅读:265      评论:0      收藏:0      [点我收藏+]

在《人月神话》一书中,提及了软件工程中必备的一个概念:自文档化。所谓自文档化,就是把文档和代码合二为一,既增强了文档的可维护性,又增强了代码的可读性,一举两得,何乐而不为呢?

Qt开发中,就有这样的自文档化工具:qdoc。使用qdoc,通常分三步走。

第一步,添加QDoc注释到必要的.cpp文件或.qdoc文件,在.h文件中添加QDoc注释是无效的。

第二步,编辑.qdocconf配置文件。

第三步,运行qdoc,默认生成HTML文档,命令如下:

$xxx/bin/qdoc ./config.qdocconf

QDoc注释和配置文件说明可通过Qt助手查看,里面有详细的介绍。

Qt的自文档化工具qdoc

原文:http://blog.csdn.net/ieearth/article/details/44939327

(0)
(0)
   
举报
评论 一句话评论(0
关于我们 - 联系我们 - 留言反馈 - 联系我们:wmxa8@hotmail.com
© 2014 bubuko.com 版权所有
打开技术之扣,分享程序人生!