您好,登錄后才能下訂單哦!
在VSCode 中如何添加自定義注釋?很多新手對此不是很清楚,為了幫助大家解決這個難題,下面小編將為大家詳細講解,有這方面需求的人可以來學習下,希望你能有所收獲。
如何設置一個自定義注釋
整潔的代碼和注釋風格總是給人一種眼前一亮、賞心悅目的感覺,同時詳細的注釋也是程序員所必須的職業素養之一
今天主要分享一下如何在VS Code中設置自定義 注釋
第一步:
使用ctrl + shift + p 調出如下窗口,并且輸入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", "-->" ], },
最后想分享一下紅色警戒的源碼 注釋的格式 ,在紅色警戒的源碼公開之后,他的注釋簡直堪稱經典
我整理了一下這段注釋,致敬經典!
"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} *", "*==================================================================================================*/" ], },
看完上述內容是否對您有幫助呢?如果還想對相關知識有進一步的了解或閱讀更多相關文章,請關注億速云行業資訊頻道,感謝您對億速云的支持。
免責聲明:本站發布的內容(圖片、視頻和文字)以原創、轉載和分享為主,文章觀點不代表本網站立場,如果涉及侵權請聯系站長郵箱:is@yisu.com進行舉報,并提供相關證據,一經查實,將立刻刪除涉嫌侵權內容。