在《人月神話》1書中,提及了軟件工程中必備的1個概念:自文檔化。所謂自文檔化,就是把文檔和代碼合2為1,既增強了文檔的可保護性,又增強了代碼的可讀性,1舉兩得,何樂而不為呢?
在Qt開發(fā)中,就有這樣的自文檔化工具:qdoc。使用qdoc,通常分3步走。
第1步,添加QDoc注釋到必要的.cpp文件或.qdoc文件,在.h文件中添加QDoc注釋是無效的。
第2步,編輯.qdocconf配置文件。
第3步,運行qdoc,默許生成HTML文檔,命令以下:
$xxx/bin/qdoc ./config.qdocconf
QDoc注釋和配置文件說明可通過Qt助手查看,里面有詳細的介紹。
下一篇 文本聚類算法介紹