原文：https://blog.csdn.net/liang19890820/article/details/54925434?

自定義注釋
注釋的原則是有助于對程序的閱讀理解，不宜太多，也不能太少（一般情況下，源代碼有效注釋量必須在 20％ 以上）。注釋的風格可根據(jù)自己的喜好自定義，但必須準確、簡潔、易懂。

說明性文件（例如：.h 文件、.inc 文件、.def 文件等）頭部應進行注釋，注釋一般需要列出：

版權說明
生成日期
作者
功能
此外，也可以列出與其它文件的關系、修改日志等，頭文件的注釋中還應有函數(shù)功能簡要說明。

那么，如何在 Qt Creator 中自動補全注釋呢？

| 版權聲明：一去、二三里，未經(jīng)博主允許不得轉載。

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

例如，觸發(fā)：“header”，觸發(fā)種類：“custom”（也可以填寫為其它內(nèi)容）。然后，填寫注釋的內(nèi)容（也可以是其它形式的代碼段）：

/**
* @projectName %{CurrentProject:Name}
* @brief 摘要
* @author Waleon
* @date %{CurrentDate:yyyy-MM-dd}
*/

點擊“OK”進行保存：

?

簡單使用
在編輯器中輸入“header”，就會關聯(lián)剛才設置的注釋：

?

這時候，注釋模板就自動添加上去了：

?

Ok，大功告成。

建議：添加一些常用的注釋模版，便于后期開發(fā)維護。
---------------------

轉載于:https://www.cnblogs.com/h2zZhou/p/10172772.html

總結

以上是生活随笔為你收集整理的【转载】Qt Creator 添加自定义注释的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。