在《人月神话》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助手查看,里面有详细的介绍。
下一篇 文本聚类算法介绍