簡述

注釋的原則是有助于對(duì)程序的閱讀理解，不宜太多，也不能太少（一般情況下，源代碼有效注釋量必須在 20％ 以上），注釋必須準(zhǔn)確、易懂、簡潔。

說明性文件（例如：.h 文件、.inc 文件、.def 文件等）頭部應(yīng)進(jìn)行注釋，注釋一般需要列出：版權(quán)說明、版本號(hào)、生成日期、作者、內(nèi)容、功能、與其它文件的關(guān)系、修改日志等，頭文件的注釋中還應(yīng)有函數(shù)功能簡要說明。

怎么在 Qt Creator 中自動(dòng)補(bǔ)全注釋呢？下面我們進(jìn)行配置說明，簡單的介紹自定義注釋的添加（注釋的風(fēng)格可根據(jù)自己的喜好自定義）。

簡述配置

版權(quán)所有：一去丶二三里，轉(zhuǎn)載請(qǐng)注明出處：http://blog.csdn.net/liang19890820

配置

打開 Qt Creator，菜單選擇：工具 -> 選項(xiàng) -> 文本編輯器 -> 段落。點(diǎn)擊“添加”按鈕，編輯自定義的“觸發(fā)”。

例如，觸發(fā)：“header”，觸發(fā)種類：“custom”（也可以填寫為其它內(nèi)容）。然后填寫注釋的內(nèi)容（也可以是其它形式的代碼段），點(diǎn)擊“確定”進(jìn)行保存。

/** * @brief 摘要 * @author 一去丶二三里 * @date 2017/02/08 */

在編輯器中輸入“header”，就會(huì)關(guān)聯(lián)剛才設(shè)置的注釋。

Ok，大功告成，注釋模板就自動(dòng)添加上去了。

建議：添加一些常用的注釋模版，便于后期開發(fā)維護(hù)。。。PS：維護(hù)別人的代碼真心傷不起吶！！！