Qt添加註釋模板

2021 年 3 月 25 日
筆記
Qt, 軟體使用

背景

軟體：Qt Creator
在寫程式碼的時候我們為了規範化，一般會加文件注釋、類注釋和函數注釋
用注釋來說明我們的程式碼，也方便模組化開發
那麼我們在寫注釋的時候經常會寫一些重複的內容，我們會複製粘貼。這樣一來二去，就顯得很繁瑣
能不能有一種注釋模板可以嵌套呢？

有的😉

設置片段

在Qt中我們依次點開【工具】→【選項】→【文本編輯器】→【片段】

然後點擊添加
輸入我們想要的片段觸發，例如filecomment（PS這樣的話我們只要在寫程式碼的時候輸入filecomment就可以顯示程式碼片段，直接回車就可以輸入了）。
然後在下面的方框輸入，想要觸發的注釋片段內容，例如：

/*! @File        : %{CurrentDocument:FileName}
 *  @Brief       : 簡要說明
 *  @Details     : 詳細說明
 *  @Author      : Kevin
 *  @Date        : %{CurrentDate:yyyy-MM-dd} %{CurrentTime:hh:mm:ss}
 *  @Version     : v1.0
 *  @Copyright   : Copyright By Kevin, All Rights Reserved
 *
 **********************************************************
 *
 *  @Attention   :
 *  @par 修改日誌:
 *  <table>
 *  <tr><th>Date       <th>Version   <th>Author    <th>Description
 *  <tr><td>%{CurrentDate:yyyy-MM-dd} <td>1.0       <td>Kevin     <td>創建初始版本
 *  </table>
 *
 **********************************************************

然後點擊右下角的Apply就可以了

相類似的程式碼片段參考如下
類注釋

/*!
    @ClassName   : Class
    @Description : Description
    @Author      : Kevin
    @Data        : %{CurrentDate:yyyy-MM-dd} %{CurrentTime:hh:mm:ss}
*/

函數注釋

/*!
    @Function    : Name
    @Description : 詳細描述
    @Author      : Kevin
    @Parameter   : 參數說明
    @Return      : 返回值說明
    @Output      : 
    @Call by     : 
    @Date        : %{CurrentDate:yyyy-MM-dd} %{CurrentTime:hh:mm:ss} 
    @Modify      : 日期加修改描述
*/

文件注釋模板

先將我們的文件注釋模板，就是上面的哪個

/*! @File        : %{CurrentDocument:FileName}
 *  @Brief       : 簡要說明
 *  @Details     : 詳細說明
 *  @Author      : Kevin
 *  @Date        : %{CurrentDate:yyyy-MM-dd} %{CurrentTime:hh:mm:ss}
 *  @Version     : v1.0
 *  @Copyright   : Copyright By Kevin, All Rights Reserved
 *
 **********************************************************
 *
 *  @Attention   :
 *  @par 修改日誌:
 *  <table>
 *  <tr><th>Date       <th>Version   <th>Author    <th>Description
 *  <tr><td>%{CurrentDate:yyyy-MM-dd} <td>1.0       <td>Kevin     <td>創建初始版本
 *  </table>
 *
 **********************************************************

寫到一個文件裡面，例如licensetemplate.txt 注意要保存為 UTF-8 的格式
然後依次點開Qt的【工具】→【選項】→【c++】→【文件命名】

在最下面那裡有個license template，在上面點瀏覽，選中剛才保存的文件
以後在創建新文件的時候，就可以自動的添加文件的注釋了，是不是很方便😁

總結

上面兩種方法都挺實用的，平常寫程式碼的時候可以用上
如果你有更好的方案，歡迎在評論區留言😉
參考部落格
//blog.csdn.net/liang19890820/article/details/54925434

Tags: Qt 軟體使用