Vscode自定義注釋模板的實現示例

更新時間：2023年07月19日 09:49:55 作者：不要影響我疊Q

本文主要介紹了Vscode自定義注釋模板的實現示例，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

首先安裝插件Doxygen Documentation Generator，安裝完成之后點擊Doxygen插件的設置，按照下面的步驟打開settings.json進行編輯：

在settings.json中追加如下代碼：

"doxdocgen.file.copyrightTag": [
        "Copyright (C), 2023,"
    ],
    "doxdocgen.file.fileTemplate": "@file \t 【文件名稱，不包含絕對路徑】",
    "doxdocgen.generic.authorTag": "@author \t 【作者】",
    "doxdocgen.generic.dateTemplate": "@date \t {date}",
    "doxdocgen.generic.briefTemplate": "@brief \t 【簡介】",
    "doxdocgen.generic.returnTemplate": "@return \t 【解釋返回值】 ",
    "doxdocgen.file.customTag": [ //文件級的自定義注釋
        "@note \t 【重大修改可以放在這里】",
    ],
    "doxdocgen.generic.customTags": [
        "@warning\t 【不可重入、阻塞等屬性特殊說明】",
        "@note\t 【重大修改】",
    ],
    "doxdocgen.generic.paramTemplate": "@param \t {param} [in/out], 參數意義",
    "doxdocgen.file.fileOrder": [
        "copyright",
        "", //這個地方表示換行
        "file",
        "author",
        "date",
        "brief",
        "custom",
    ],
    "doxdocgen.generic.order": [
        "brief",
        "param",
        "return",
        "custom"
    ]

切回vscode，在函數上方輸入/***/，然后再第二個*后面按一下enter鍵，自定義注釋模板即可生效，如下圖：

多插一句嘴，我的主題插件是Visual Assist Dark Theme插件，改編自visual studio上的西紅柿助手主題顏色。個人感覺還是挺好看的

到此這篇關于Vscode自定義注釋模板的實現示例的文章就介紹到這了,更多相關Vscode自定義注釋模板內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章:

C++ 實現的通訊錄管理系統詳解
這篇文章主要為大家詳細介紹了C++實現通訊錄管理系統，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下
2021-10-10
C++中vector可以作為map的鍵值實例代碼
這篇文章主要介紹了C++中vector可以作為map的鍵值實例代碼,需要的朋友可以參考下
2017-07-07
C語言中二級指針的實例詳解
這篇文章主要介紹了C語言中二級指針的實例詳解的相關資料,希望通過本文能幫助到大家，讓大家掌握理解二級指針的知識，需要的朋友可以參考下
2017-10-10
C++詳解哈夫曼樹的概念與實現步驟
給定N個權值作為N個葉子結點，構造一棵二叉樹，若該樹的帶權路徑長度達到最小，稱這樣的二叉樹為最優(yōu)二叉樹，也稱為哈夫曼樹(Huffman?Tree)。哈夫曼樹是帶權路徑長度最短的樹，權值較大的結點離根較近
2022-04-04
C++中jsoncpp庫和nlohmann-json庫實現JSON與字符串類型轉換
jsoncpp是ROS自帶的一個JSON庫,它提供了一些函數來解析和生成JSON數據,在ROS中,可以使用jsoncpp庫來實現JSON與字符串類型之間的轉換,這篇文章主要介紹了jsoncpp庫和nlohmann-json庫實現JSON與字符串類型轉換,需要的朋友可以參考下
2023-08-08
實戰(zhàn)開發(fā)為單片機的按鍵加一個鎖防止多次觸發(fā)的細節(jié)
今天小編就為大家分享一篇關于實戰(zhàn)開發(fā)為單片機的按鍵加一個鎖防止多次觸發(fā)的細節(jié)，小編覺得內容挺不錯的，現在分享給大家，具有很好的參考價值，需要的朋友一起跟隨小編來看看吧
2018-12-12
C語言rewind與fseek函數之隨機讀寫文件的用法詳解
這篇文章主要介紹了C語言rewind與fseek函數之隨機讀寫文件的用法詳解,本篇文章通過簡要的案例,講解了該項技術的了解與使用,以下就是詳細內容,需要的朋友可以參考下
2021-09-09
C語言實現動態(tài)版通訊錄的示例代碼
這篇文章主要為大家詳細介紹了如何利用C語言實現一個簡單的動態(tài)版通訊錄，文中的示例代碼講解詳細，對我們學習C語言有一定幫助，需要的可以參考一下
2022-08-08
C++中類的默認成員函數詳解
大家好，本篇文章主要講的是C++中類的默認成員函數詳解，感興趣的同學趕快來看一看吧，對你有幫助的話記得收藏一下
2022-01-01
Qt 使用Poppler實現pdf閱讀器的示例代碼
下面小編就為大家分享一篇Qt 使用Poppler實現pdf閱讀器的示例代碼，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧
2018-01-01