注釋的原則是有助于對程式的閱讀了解，不宜太多，也不能太少（一般情況下，源代碼有效注釋量必須在 20％ 以上），注釋必須準确、易懂、簡潔。
說明性檔案（例如：.h 檔案、.inc 檔案、.def 檔案等）頭部應進行注釋，注釋一般需要列出：版權說明、版本号、生成日期、作者、内容、功能、與其它檔案的關系、修改日志等，頭檔案的注釋中還應有函數功能簡要說明。
怎麼在 qt creator 中自動補全注釋呢？下面我們進行配置說明，簡單的介紹自定義注釋的添加（注釋的風格可根據自己的喜好自定義）。
<a href="#%e7%ae%80%e8%bf%b0">簡述</a>
<a href="#%e9%85%8d%e7%bd%ae">配置</a>
<a href="#%e6%9b%b4%e5%a4%9a%e5%8f%82%e8%80%83">更多參考</a>
打開 qt creator，菜單選擇：工具 -> 選項 -> 文本編輯器 -> 片段。點選“添加”按鈕，編輯自定義的“觸發”。
例如，觸發：“header”，觸發種類：“custom”（也可以填寫為其它内容）。然後填寫注釋的内容（也可以是其它形式的代碼段），點選“确定”進行儲存。
/** * @brief 摘要 * @author 一去丶二三裡 * @date 2017/02/08 */
在編輯器中輸入“header”，就會關聯剛才設定的注釋。
ok，大功告成，注釋模闆就自動添加上去了。
建議：添加一些常用的注釋模版，便于後期開發維護。。。ps：維護别人的代碼真心傷不起呐！！！
<a href="https://stackoverflow.com/questions/34762739/qt-creator-placeholders">qt creator placeholders</a>
<a href="https://bugreports.qt.io/browse/qtcreatorbug-14726%5d">qtcreatorbug-14726</a>
<a href="https://codedump.io/share/oceleecc0vgb/1/qt-creator-placeholders">qt creator placeholders</a>