Qt?QtCreator添加自定義注釋的實現(xiàn)方法
更新時間：2023年11月03日 11:44:10 作者：Mr.codeee
在寫代碼的時候我們?yōu)榱艘?guī)范化,一般會加文件注釋、類注釋和函數(shù)注釋,本文主要介紹了Qt?QtCreator添加自定義注釋的實現(xiàn)方法,具有一定的參考價值,感興趣的可以了解一下
在寫代碼的時候我們?yōu)榱艘?guī)范化，一般會加文件注釋、類注釋和函數(shù)注釋；用注釋來說明我們的代碼，也方便模塊化開發(fā)，那么我們在寫注釋的時候經(jīng)常會寫一些重復(fù)的內(nèi)容，我們會復(fù)制粘貼。這樣一來二去，就顯得很繁瑣。
說明性文件（例如：.h 文件、.inc 文件、.def 文件等）頭部應(yīng)進(jìn)行注釋，注釋一般需要列出：
版權(quán)說明生成日期作者功能
下面介紹QtCreator自定義的注釋配置。
設(shè)置片段
在Qt中我們依次點開【工具】→【選項】→【文本編輯器】→【片段】
文件注釋模板：
例如，觸發(fā)：“filee”，觸發(fā)種類：“custom”（也可以填寫為其它內(nèi)容）。然后，填寫注釋的內(nèi)容（也可以是其它形式的代碼段）：
/*! @File : %{CurrentDocument:FileName}
* @Brief : 簡要說明
* @Details : 詳細(xì)說明
* @Author : xxx
* @Date : %{CurrentDate:yyyy-MM-dd}
* @Version : v1.0
* @Copyright : Copyright By xxx, 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>xxx <td>創(chuàng)建初始版本
* </table>
*
**********************************************************
*/在編輯器中輸入filee，按回車，就會打印出注釋語句。
類似的還有函數(shù)注釋、類注釋。
函數(shù)注釋模板：
/*!
@Function : Name
@Description : 詳細(xì)描述
@Author : xxx
@Parameter : 參數(shù)說明
@Return : 返回值說明
@Output :
@Date : %{CurrentDate:yyyy-MM-dd} %{CurrentTime:hh:mm:ss}
@Modify : 日期加修改描述
*/類注釋模板：
/*!
@ClassName : Class
@Description : Description
@Author : xxx
@Data : %{CurrentDate:yyyy-MM-dd} %{CurrentTime:hh:mm:ss}
*/還有一種QtCreator自帶的注釋：
輸入 /** 然后回車就會出現(xiàn)注釋語句。
到此這篇關(guān)于Qt QtCreator添加自定義注釋的實現(xiàn)方法的文章就介紹到這了,更多相關(guān)Qt QtCreator 自定義注釋內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
這篇文章主要為大家詳細(xì)介紹了C語言實現(xiàn)關(guān)機小程序，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價值，感興趣的小伙伴們可以參考一下2020-02-02
C語言實現(xiàn)時間戳轉(zhuǎn)日期的算法(推薦)
下面小編就為大家?guī)硪黄狢語言實現(xiàn)時間戳轉(zhuǎn)日期的算法(推薦)。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2016-06-06
const名叫常量限定符，用來限定特定變量，以通知編譯器該變量是不可修改的,本文為大家整理了const的幾種使用，感興趣的小伙伴可以跟隨小編一起了解一下2023-06-06
sizeof操作符以字節(jié)形式給出了其操作數(shù)的存儲大小2013-04-04
本文詳細(xì)介紹了如何使用C語言編寫一個簡單的TCP服務(wù)器,包括創(chuàng)建套接字、綁定IP和端口、監(jiān)聽連接請求、接受客戶端連接、數(shù)據(jù)接收與發(fā)送以及關(guān)閉套接字等步驟,最后通過一個簡單的示例展示了TCP服務(wù)器的基本實現(xiàn)過程2024-10-10
這篇文章主要為大家詳細(xì)介紹了C語言模擬實現(xiàn)字符串庫函數(shù)的具體方法,本文通過實例代碼給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下2023-01-01
今天小編就為大家分享一篇關(guān)于查找算法之二分查找的C++實現(xiàn)，小編覺得內(nèi)容挺不錯的，現(xiàn)在分享給大家，具有很好的參考價值，需要的朋友一起跟隨小編來看看吧2018-12-12
Qt數(shù)據(jù)庫應(yīng)用之?dāng)?shù)據(jù)打印到pdf
因為xls打開以后用戶可以修改數(shù)據(jù)造假之類的，而pdf默認(rèn)是不可編輯的，除非借助專業(yè)的工具，所以如果想要限定用戶導(dǎo)出數(shù)據(jù)不能被更改，那導(dǎo)出pdf是最佳選擇。所以本文將為代價介紹Qt實現(xiàn)數(shù)據(jù)打印到pdf的方法，需要的可以參考一下2022-01-01
這篇文章主要介紹了C++指針與引用的異同，文章以C++指針與引用的相關(guān)資料結(jié)合指針和引用的相同點和區(qū)別展開詳細(xì)內(nèi)容,需要的朋友可以參考一下2021-11-11
本文粗淺比較了C語言中常用的幾種讀取文件的函數(shù)的效率，并給出了幾段求取某列平均值的代碼，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多度進(jìn)步2022-02-02