VSCode 添加自定義注釋的方法(附帶紅色警戒經(jīng)典注釋風格)

更新時間：2020年08月27日 14:58:50 作者：Coder小何

這篇文章主要介紹了VSCode 添加自定義注釋的方法(附帶紅色警戒經(jīng)典注釋風格),本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下

如何設置一個自定義注釋

整潔的代碼和注釋風格總是給人一種眼前一亮、賞心悅目的感覺，同時詳細的注釋也是程序員所必須的職業(yè)素養(yǎng)之一
今天主要分享一下如何在VS Code中設置自定義注釋

第一步:

使用ctrl + shift + p 調(diào)出如下窗口，并且輸入snippets

在這里插入圖片描述

第二步：進入json文件編輯

這里以自定義js注釋為例：

在這里插入圖片描述

進入到 json 文件中后，添加如下代碼，大家可以自定義設計，保存退出我這里是一個類注釋一個方法注釋

"Print to js class": {
    "prefix": "zhushiclass",
    "body": [
      "/*",
      " *@Description: $0",
      " *@ClassAuthor: Tian Qin",
      " *@Date: ${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE} ${CURRENT_HOUR}:${CURRENT_MINUTE}:${CURRENT_SECOND}",
      "*/"
    ],
  },
  "Print to js method": {
    "prefix": "zhushimethod",
    "body": [
      "/*",
      " *@Description: $0",
      " *@MethodAuthor: HeLihui",
      " *@Date: ${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE} ${CURRENT_HOUR}:${CURRENT_MINUTE}:${CURRENT_SECOND}",
      "*/"
    ],
  },

第三步：

保存退出后，我們可以在js文件中看到智能提示

在這里插入圖片描述

點擊之后會自動生成注釋，同時date會自動生成

在這里插入圖片描述

注意一下，這里html注釋稍有不同
因為html注釋格式為 < - - ！ - - >

"Print to html method": {
    "prefix": "zhushihtml",
    "body": [
			"<!-- ",
      "**@Description: $0",
			"-->"
    ],
  },

最后想分享一下紅色警戒的源碼注釋的格式，在紅色警戒的源碼公開之后，他的注釋簡直堪稱經(jīng)典
我整理了一下這段注釋，致敬經(jīng)典！

 "Print to js api": {
    "prefix": "hongsejingjie",
    "body": [
      "/***************************************************************************************************",
      " * AircraftClass :: $0                                        *",
      " *        @Description: $0                                 *",
      " *        @Description: $0                                 *",
      " *        @Description: $0                                 *",
      " *                                                 *",
      " * INPUT:$0                                            *",
      " *                                                 *",
      " * OUTPUT:$0                                            *",
      " *                                                 *",
      " * WARNINGS:$0                                           *",
      " * HISTORY:                                            *",
      " *     @MethodAuthor: HeLihui                                 *",
      " *     @Date: ${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE} ${CURRENT_HOUR}         *",
      "*==================================================================================================*/"
    ],
  },

在這里插入圖片描述

由于這是我自己整理出來的，所以效果不是很好，所以大家請見諒，也希望大家能夠繼續(xù)完善

在這里插入圖片描述

總結(jié)

到此這篇關于VSCode 添加自定義注釋(附帶紅色警戒經(jīng)典注釋風格)的文章就介紹到這了,更多相關VSCode 添加自定義注釋內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章:

Vscode自定義注釋模板的實現(xiàn)示例

JavaScript 動態(tài)三角函數(shù)實例詳解
本文通過實例代碼給大家實例講解了javascript動態(tài)三角函數(shù)知識，非常不錯，具有參考借鑒價值，需要的朋友參考下
2017-01-01
js變換顯示圖片的實例
題意：在界面上有一張圖片，下面有四個單選按鈕，點擊每一個按鈕圖片變換成不同的圖片
2013-04-04
Javascript中Microtask和Macrotask鮮為人知的知識點
這篇文章主要為大家介紹了Javascript中Microtask和Macrotask鮮為人知的知識點講解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步早日升職加薪
2022-04-04
javascript截取字符串(通過substring實現(xiàn)并支持中英文混合)
用js方法substring()、方法substr()實現(xiàn)如標題所示的截取字符串并支持中英文混合，具體代碼如下，感興趣的各位可以參考下哈
2013-06-06
JS仿JQuery選擇器功能
本文主要介紹了JS仿JQuery選擇器功能的實例，具有很好的參考價值。下面跟著小編一起來看下吧
2017-03-03
一文詳解uniapp中如何使用easycom自定義組件
easycom是uniapp的一種組件自動引入的規(guī)則,使用這種規(guī)則可以使?jié)M足規(guī)則的組件無需注冊直接使用,下面這篇文章主要給大家介紹了關于uniapp中如何使用easycom自定義組件的相關資料,需要的朋友可以參考下
2023-05-05
js獲取所有checkbox的值的簡單實例
下面小編就為大家?guī)硪黄猨s獲取所有checkbox值的簡單實例。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧
2016-05-05
一款好用的移動端滾動插件BetterScroll
BetterScroll 是一款重點解決移動端各種滾動場景需求的開源插件，用于滾動列表、選擇器、輪播圖、索引列表、開屏引導等應用場景，感興趣的一起來了解一下
2021-09-09
ES6中的Promise對象與async和await方法詳解
Promise是es6引入的異步編程薪解決方案，語法上promise就是一個構(gòu)造函數(shù)，用來封裝異步操作病可以獲取其成功或失敗的結(jié)果，這篇文章主要介紹了ES6中的Promise對象與async和await方法,需要的朋友可以參考下
2022-12-12
數(shù)組方法解決JS字符串連接性能問題有爭議
大多數(shù)情況下，加法運算符是首選；如果用戶主要使用IE6或7，并且字符串大小較大或數(shù)量較多時，那么數(shù)組技術就很值得。
2011-01-01