Qt?QtCreator添加自定義注釋的實(shí)現(xiàn)方法
在寫代碼的時(shí)候我們?yōu)榱艘?guī)范化,一般會(huì)加文件注釋、類注釋和函數(shù)注釋;用注釋來(lái)說(shuō)明我們的代碼,也方便模塊化開發(fā),那么我們?cè)趯懽⑨尩臅r(shí)候經(jīng)常會(huì)寫一些重復(fù)的內(nèi)容,我們會(huì)復(fù)制粘貼。這樣一來(lái)二去,就顯得很繁瑣。
說(shuō)明性文件(例如:.h 文件、.inc 文件、.def 文件等)頭部應(yīng)進(jìn)行注釋,注釋一般需要列出:
版權(quán)說(shuō)明生成日期作者功能
下面介紹QtCreator自定義的注釋配置。
設(shè)置片段
在Qt中我們依次點(diǎn)開【工具】→【選項(xiàng)】→【文本編輯器】→【片段】
文件注釋模板:
例如,觸發(fā):“filee”,觸發(fā)種類:“custom”(也可以填寫為其它內(nèi)容)。然后,填寫注釋的內(nèi)容(也可以是其它形式的代碼段):
/*! @File : %{CurrentDocument:FileName} * @Brief : 簡(jiǎn)要說(shuō)明 * @Details : 詳細(xì)說(shuō)明 * @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,按回車,就會(huì)打印出注釋語(yǔ)句。
類似的還有函數(shù)注釋、類注釋。
函數(shù)注釋模板:
/*! @Function : Name @Description : 詳細(xì)描述 @Author : xxx @Parameter : 參數(shù)說(shuō)明 @Return : 返回值說(shuō)明 @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自帶的注釋:
輸入 /** 然后回車就會(huì)出現(xiàn)注釋語(yǔ)句。
到此這篇關(guān)于Qt QtCreator添加自定義注釋的實(shí)現(xiàn)方法的文章就介紹到這了,更多相關(guān)Qt QtCreator 自定義注釋內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
深入C++浮點(diǎn)數(shù)無(wú)效值定義與判定的解決辦法
本篇文章是對(duì)C++中浮點(diǎn)數(shù)無(wú)效值定義與判定進(jìn)行了介紹,需要的朋友參考下2013-05-05C語(yǔ)言使用scanf連續(xù)輸入字符串出現(xiàn)的問(wèn)題
這篇文章主要介紹了C語(yǔ)言使用scanf連續(xù)輸入字符串出現(xiàn)的問(wèn)題,本文給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2020-12-12C++中使用FFmpeg適配自定義編碼器的實(shí)現(xiàn)方法
本文介紹了在C++中使用FFmpeg庫(kù)進(jìn)行自定義編碼器適配的實(shí)現(xiàn)方法。文章通過(guò)具體的代碼示例,介紹了FFmpeg的基本使用方法和自定義編碼器的實(shí)現(xiàn)過(guò)程,幫助讀者了解如何在C++中進(jìn)行音視頻編碼和解碼的開發(fā)工作,并能夠?qū)崿F(xiàn)自定義的編碼器適配2023-04-04Qt物聯(lián)網(wǎng)管理平臺(tái)之實(shí)現(xiàn)數(shù)據(jù)查詢導(dǎo)出打印
這篇文章主要為大家介紹了如何利用Qt編寫物聯(lián)網(wǎng)管理平臺(tái)中數(shù)據(jù)查詢導(dǎo)出打印的功能,文字的示例代碼講解詳細(xì),感興趣的可以了解一下2022-07-07VScode配置C++運(yùn)行環(huán)境的完整步驟
這篇文章主要給大家介紹了關(guān)于VScode配置C++運(yùn)行環(huán)境的完整步驟,文中通過(guò)圖文介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2021-01-01Opencv2.4.9函數(shù)HoughLinesP分析
這篇文章主要為大家詳細(xì)介紹了Opencv2.4.9函數(shù)HoughLinesP,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2019-01-01