Qt的自文檔化工具qdoc

在《人月神話(huà)》1書(shū)中，提及了軟件工程中必備的1個(gè)概念：自文檔化。所謂自文檔化，就是把文檔和代碼合2為1，既增強(qiáng)了文檔的可保護(hù)性，又增強(qiáng)了代碼的可讀性，1舉兩得，何樂(lè)而不為呢？

在Qt開(kāi)發(fā)中，就有這樣的自文檔化工具：qdoc。使用qdoc，通常分3步走。

第1步，添加QDoc注釋到必要的.cpp文件或.qdoc文件，在.h文件中添加QDoc注釋是無(wú)效的。

第2步，編輯.qdocconf配置文件。

第3步，運(yùn)行qdoc，默許生成HTML文檔，命令以下：

$xxx/bin/qdoc ./config.qdocconf

QDoc注釋和配置文件說(shuō)明可通過(guò)Qt助手查看，里面有詳細(xì)的介紹。

生活不易，碼農(nóng)辛苦
如果您覺(jué)得本網(wǎng)站對(duì)您的學(xué)習(xí)有所幫助,可以手機(jī)掃描二維碼進(jìn)行捐贈(zèng)