国内最全IT社区平台 联系我们 | 收藏本站
华晨云阿里云优惠2
您当前位置:首页 > php开源 > 综合技术 > Qt的自文档化工具qdoc

Qt的自文档化工具qdoc

来源:程序员人生   发布时间:2015-04-14 08:37:45 阅读次数:8712次

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

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

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

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

第3步,运行qdoc,默许生成HTML文档,命令以下:

$xxx/bin/qdoc ./config.qdocconf

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

生活不易,码农辛苦
如果您觉得本网站对您的学习有所帮助,可以手机扫描二维码进行捐赠
程序员人生
------分隔线----------------------------
分享到:
------分隔线----------------------------
关闭
程序员人生