脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 网络编程 → JavaScript → javascript技巧 → VSCode 添加自定义注释

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 添加自定义注释内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • JavaScript 动态三角函数实例详解

    JavaScript 动态三角函数实例详解

    本文通过实例代码给大家实例讲解了javascript动态三角函数知识，非常不错，具有参考借鉴价值，需要的朋友参考下
    2017-01-01
  • js变换显示图片的实例

    js变换显示图片的实例

    题意：在界面上有一张图片，下面有四个单选按钮，点击每一个按钮图片变换成不同的图片
    2013-04-04
  • Javascript中Microtask和Macrotask鲜为人知的知识点

    Javascript中Microtask和Macrotask鲜为人知的知识点

    这篇文章主要为大家介绍了Javascript中Microtask和Macrotask鲜为人知的知识点讲解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步早日升职加薪
    2022-04-04
  • javascript截取字符串(通过substring实现并支持中英文混合)

    javascript截取字符串(通过substring实现并支持中英文混合)

    用js方法substring()、方法substr()实现如标题所示的截取字符串并支持中英文混合，具体代码如下，感兴趣的各位可以参考下哈
    2013-06-06
  • JS仿JQuery选择器功能

    JS仿JQuery选择器功能

    本文主要介绍了JS仿JQuery选择器功能的实例，具有很好的参考价值。下面跟着小编一起来看下吧
    2017-03-03
  • 一文详解uniapp中如何使用easycom自定义组件

    一文详解uniapp中如何使用easycom自定义组件

    easycom是uniapp的一种组件自动引入的规则,使用这种规则可以使满足规则的组件无需注册直接使用,下面这篇文章主要给大家介绍了关于uniapp中如何使用easycom自定义组件的相关资料,需要的朋友可以参考下
    2023-05-05
  • js获取所有checkbox的值的简单实例

    js获取所有checkbox的值的简单实例

    下面小编就为大家带来一篇js获取所有checkbox值的简单实例。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2016-05-05
  • 一款好用的移动端滚动插件BetterScroll

    一款好用的移动端滚动插件BetterScroll

    BetterScroll 是一款重点解决移动端各种滚动场景需求的开源插件，用于滚动列表、选择器、轮播图、索引列表、开屏引导等应用场景，感兴趣的一起来了解一下
    2021-09-09
  • ES6中的Promise对象与async和await方法详解

    ES6中的Promise对象与async和await方法详解

    Promise是es6引入的异步编程薪解决方案，语法上promise就是一个构造函数，用来封装异步操作病可以获取其成功或失败的结果，这篇文章主要介绍了ES6中的Promise对象与async和await方法,需要的朋友可以参考下
    2022-12-12
  • 数组方法解决JS字符串连接性能问题有争议

    数组方法解决JS字符串连接性能问题有争议

    大多数情况下，加法运算符是首选；如果用户主要使用IE6或7，并且字符串大小较大或数量较多时，那么数组技术就很值得。
    2011-01-01

最新评论