簡述

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

說明性文件（例如：.h 文件、.inc 文件、.def 文件等）頭部應進行注釋，注釋一般需要列出：版權說明、版本號、生成日期、作者、內容、功能、與其它文件的關系、修改日志等，頭文件的注釋中還應有函數功能簡要說明。

怎么在 Qt Creator 中自動補全注釋呢？下面我們進行配置說明，簡單的介紹自定義注釋的添加（注釋的風格可根據自己的喜好自定義）。

簡述配置

版權所有：一去丶二三里，轉載請注明出處：http://blog.csdn.net/liang19890820

配置

打開 Qt Creator，菜單選擇：工具 -> 選項 -> 文本編輯器 -> 段落。點擊“添加”按鈕，編輯自定義的“觸發”。

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

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

在編輯器中輸入“header”，就會關聯剛才設置的注釋。

Ok，大功告成，注釋模板就自動添加上去了。

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