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

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

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

如何設(shè)置一個自定義注釋

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

第一步:

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

在這里插入圖片描述

第二步：進入json文件編輯

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

在這里插入圖片描述

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

"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}         *",
      "*==================================================================================================*/"
    ],
  },

在這里插入圖片描述