VSCode 添加自定义注释的方法(附带红色警戒经典注释风格)


Posted in Javascript onAugust 27, 2020

如何设置一个自定义注释

整洁的代码和注释风格总是给人一种眼前一亮、赏心悦目的感觉,同时详细的注释也是程序员所必须的职业素养之一
今天主要分享一下如何在VS Code中设置自定义 注释

第一步:

使用ctrl + shift + p 调出如下窗口,并且输入snippets

VSCode 添加自定义注释的方法(附带红色警戒经典注释风格)

第二步:进入json文件编辑

这里以自定义js注释为例:

VSCode 添加自定义注释的方法(附带红色警戒经典注释风格)

进入到 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文件中看到智能提示

VSCode 添加自定义注释的方法(附带红色警戒经典注释风格)

点击之后会自动生成注释 ,同时date会自动生成

VSCode 添加自定义注释的方法(附带红色警戒经典注释风格)

注意一下,这里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 添加自定义注释的方法(附带红色警戒经典注释风格)

由于这是我自己整理出来的,所以效果不是很好,所以大家请见谅,也希望大家能够继续完善

VSCode 添加自定义注释的方法(附带红色警戒经典注释风格)

总结

到此这篇关于VSCode 添加自定义注释(附带红色警戒经典注释风格)的文章就介绍到这了,更多相关VSCode 添加自定义注释内容请搜索三水点靠木以前的文章或继续浏览下面的相关文章希望大家以后多多支持三水点靠木!

Javascript 相关文章推荐
js/ajax跨越访问-jsonp的原理和实例(javascript和jquery实现代码)
Dec 27 Javascript
一个JavaScript的求爱小特效
May 09 Javascript
JavaScript实现更改网页背景与字体颜色的方法
Feb 02 Javascript
jquery实现点击展开列表同时隐藏其他列表
Aug 10 Javascript
javascript 广告移动特效的实现代码
Jun 25 Javascript
原生JS实现的放大镜效果实例代码
Oct 15 Javascript
利用JS轻松实现获取表单数据
Dec 06 Javascript
jquery Ajax实现Select动态添加数据
Jun 08 jQuery
详解jQuery中的easyui
Sep 02 jQuery
JS数组实现分类统计实例代码
Sep 30 Javascript
Javascript Worker子线程代码实例
Feb 20 Javascript
JavaScript实现手风琴效果
Feb 18 Javascript
js实现弹幕飞机效果
Aug 27 #Javascript
jQuery编写QQ简易聊天框
Aug 27 #jQuery
jQuery实现简单QQ聊天框
Aug 27 #jQuery
js实现前端界面导航栏下拉列表
Aug 27 #Javascript
selenium 反爬虫之跳过淘宝滑块验证功能的实现代码
Aug 27 #Javascript
JS实现拖拽元素时与另一元素碰撞检测
Aug 27 #Javascript
js实现QQ邮箱邮件拖拽删除功能
Aug 27 #Javascript
You might like
php数组函数序列之array_search()- 按元素值返回键名
2011/11/04 PHP
使用CodeIgniter的类库做图片上传
2014/06/12 PHP
ThinkPHP的Widget扩展实例
2014/06/19 PHP
php防止网站被刷新的方法汇总
2014/12/01 PHP
PHP类的封装与继承详解
2015/09/29 PHP
用RadioButten或CheckBox实现div的显示与隐藏
2013/09/21 Javascript
js传参数受特殊字符影响错误的解决方法
2013/10/21 Javascript
js调试系列 控制台命令行API使用方法
2014/06/18 Javascript
javascript学习笔记(四)function函数部分
2014/09/30 Javascript
js+css实现tab菜单切换效果的方法
2015/01/20 Javascript
基于ajax实现文件上传并显示进度条
2015/08/03 Javascript
JS随机洗牌算法之数组随机排序
2016/03/23 Javascript
JS控制伪元素的方法汇总
2016/04/06 Javascript
Bootstrap CSS组件之导航条(navbar)
2016/12/17 Javascript
Vue-cli项目获取本地json文件数据的实例
2018/03/07 Javascript
原生javascript AJAX 三级联动的实现代码
2018/05/04 Javascript
Vue+element-ui 实现表格的分页功能示例
2018/08/18 Javascript
示例vue 的keep-alive缓存功能的实现
2018/12/13 Javascript
如何阻止小程序遮罩层下方图层滚动
2019/09/05 Javascript
ant design vue导航菜单与路由配置操作
2020/10/28 Javascript
[31:29]完美世界DOTA2联赛PWL S3 INK ICE vs Magma 第一场 12.20
2020/12/23 DOTA
python封装对象实现时间效果
2020/04/23 Python
对python dataframe逻辑取值的方法详解
2019/01/30 Python
pandas删除指定行详解
2019/04/04 Python
Python和Anaconda和Pycharm安装教程图文详解
2020/02/04 Python
Pyinstaller打包Scrapy项目的实现步骤
2020/09/22 Python
澳洲女装时尚在线:Blue Bungalow
2018/05/05 全球购物
英国异国风情旅游网站:Travel Talk Tours(团体旅游、探险旅游、帆船假期)
2018/07/26 全球购物
Shopbop中文官网:美国亚马逊旗下时尚购物网站
2020/12/15 全球购物
大学生实习证明范本
2014/01/15 职场文书
浪漫婚礼主持词
2014/03/14 职场文书
2014年文学毕业生自我鉴定
2014/04/23 职场文书
综合管理员岗位职责
2015/02/11 职场文书
搞笑婚庆主持词
2015/06/29 职场文书
2016优秀护士先进个人事迹材料
2016/02/25 职场文书
CSS中实现动画效果-附案例
2022/02/28 HTML / CSS