VSCode 添加自定义注释的方法(附带红色警戒经典注释风格)
更新时间：2020年08月27日 14:58:50 作者：Coder小何
这篇文章主要介绍了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} *",
"*==================================================================================================*/"
],
},
由于这是我自己整理出来的，所以效果不是很好，所以大家请见谅，也希望大家能够继续完善
总结
到此这篇关于VSCode 添加自定义注释(附带红色警戒经典注释风格)的文章就介绍到这了,更多相关VSCode 添加自定义注释内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
您可能感兴趣的文章:
相关文章
全局数据共享 全局数据共享(状态管理)是为了解决组件之间数据共享的问题，开发中常用的全局数据共享方案有：Vuex、Redux、MobX等，这篇文章主要介绍了微信小程序中如何使用store数据共享,需要的朋友可以参考下2023-04-04
这篇文章主要为大家详细介绍了JavaScript实现鼠标经过表格行给出颜色标识，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2021-04-04
这篇文章主要介绍了JS实现字符串翻转的方法,结合实例形式分析了javascript字符串使用reverse方法、字符串遍历方法以及针对输入字符串的遍历、逆序输出等方法实现字符串反转相关操作技巧,需要的朋友可以参考下2018-08-08
本文通过实例代码给大家介绍了js冒泡排序和选择排序的实现代码，代码简单易懂，非常不错，具有参考借鉴价值，感兴趣的朋友一起学习吧2016-09-09
这篇文章主要介绍了JavaScript控制按钮可用或不可用的方法,主要通过设置按钮disabled属性来实现这一功能,需要的朋友可以参考下2015-04-04![PPK 谈 JavaScript 的 this 关键字 [翻译]](//img.jbzj.com/images/xgimg/bcimg5.png)
PPK 谈 JavaScript 的 this 关键字 [翻译]
在 JavaScript 中 this 是最强的关键字之一。这篇贴文就是要告诉你如何用好 this。2009-09-09
这篇文章主要介绍了JSON字符串和JSON对象相互转化方法,结合实例形式详细分析了json对象与字符串的功能、使用、转换方法及相关注意事项,需要的朋友可以参考下2017-01-01
这篇文章主要为大家介绍了使用Nest.js实现接口教程示例详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪2022-10-10
JavaScript Base64编码和解码，实现URL参数传递。
JavaScript Base64编码和解码，实现URL参数传递。...2006-09-09
这篇文章主要介绍了JS实现的计数排序与基数排序算法,结合实例形式简单分析了计数排序与基数排序的原理与JS实现技巧,需要的朋友可以参考下2017-12-12
![PPK 谈 JavaScript 的 this 关键字 [翻译]](http://img.jbzj.com/images/xgimg/bcimg5.png)
最新评论