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

网络编程 2024/11/17 佚名

3 1 2

如何设置一个自定义注释

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

华山资源网 Design By www.eoogi.com

广告合作：本站广告合作请联系QQ：858582 申请时备注：广告合作（否则不回）
免责声明：本站资源来自互联网收集,仅供用于学习和交流,请遵循相关法律法规,本站一切资源不代表本站立场,如有侵权、后门、不妥请联系本站删除！

华山资源网 Design By www.eoogi.com

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

暂无评论...

《魔兽世界》大逃杀！60人新游玩模式《强袭风暴》3月21日上线

暴雪近日发布了《魔兽世界》10.2.6 更新内容，新游玩模式《强袭风暴》即将于3月21 日在亚服上线，届时玩家将前往阿拉希高地展开一场 60 人大逃杀对战。

艾泽拉斯的冒险者已经征服了艾泽拉斯的大地及遥远的彼岸。他们在对抗世界上最致命的敌人时展现出过人的手腕，并且成功阻止终结宇宙等级的威胁。当他们在为即将于《魔兽世界》资料片《地心之战》中来袭的萨拉塔斯势力做战斗准备时，他们还需要在熟悉的阿拉希高地面对一个全新的敌人──那就是彼此。在《巨龙崛起》10.2.6 更新的《强袭风暴》中，玩家将会进入一个全新的海盗主题大逃杀式限时活动，其中包含极高的风险和史诗级的奖励。
《强袭风暴》不是普通的战场，作为一个独立于主游戏之外的活动，玩家可以用大逃杀的风格来体验《魔兽世界》，不分职业、不分装备（除了你在赛局中捡到的），光是技巧和战略的强弱之分就能决定出谁才是能坚持到最后的赢家。本次活动将会开放单人和双人模式，玩家在加入海盗主题的预赛大厅区域前，可以从强袭风暴角色画面新增好友。游玩游戏将可以累计名望轨迹，《巨龙崛起》和《魔兽世界：巫妖王之怒经典版》的玩家都可以获得奖励。

更新日志

2024年11月17日

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

vue select 获取value和lable操作

js实现弹幕飞机效果

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

《魔兽世界》大逃杀！60人新游玩模式《强袭风暴》3月21日上线

更新日志

友情链接