返回

骚注释:一键给你的 VSCode 注释里加点“神兽护体”

前端

给你的 VSCode 添点骚气,注释一下佛祖保佑永无 BUG

作为一名勤劳的码农,每天对着电脑敲敲打打,希望程序员小姐姐保佑自己手速飞快、无 BUG 纷扰。

那么,有没有什么骚操作可以给我们的代码注释增添一点趣味性呢?

最近我发现了一个神器——VSCode 插件「koroFileHeader」,它可以一键添加佛祖保佑、神兽护体等注释图形,让你的代码瞬间变得有滋有味。

使用方式

  1. 打开 VSCode,在扩展商店中搜索「koroFileHeader」并安装。
  2. 重启 VSCode。
  3. 在代码中选中需要添加注释的区域。
  4. 按下快捷键「Ctrl + Alt + H」(Windows)或「Command + Option + H」(Mac)。
  5. 在弹出的菜单中选择你喜欢的注释图形。

比如,我想给这段代码添加一个佛祖保佑的注释:

function add(a, b) {
  return a + b;
}

选中代码后,按下快捷键「Ctrl + Alt + H」,在弹出的菜单中选择「佛祖保佑」,代码就会变成这样:

// 佛祖保佑永无BUG
function add(a, b) {
  return a + b;
}

是不是瞬间骚气了起来?

骚气背后的骚操作

这个插件是如何实现这个骚操作的呢?

其实很简单,它是在代码注释中插入了一张图片。图片的内容就是你选择的注释图形。

比如,佛祖保佑的注释图形是一张佛祖的图片,图片的地址是「https://raw.githubusercontent.com/koronel/koroFileHeader/main/images/buddha.png」。

在代码中插入图片的语法如下:

<!--suppress HtmlDeprecatedTag -->
<img src="https://raw.githubusercontent.com/koronel/koroFileHeader/main/images/buddha.png">

由于代码注释中允许使用 HTML 标记,所以我们可以将图片插入到注释中。

自定义注释图形

如果你觉得默认的注释图形不够骚气,还可以自己自定义注释图形。

在插件的设置页面中,找到「Custom Image URL」选项,填写你喜欢的注释图形的地址即可。

比如,我想用一只可爱的小猫咪作为注释图形,可以将地址填写为「https://www.example.com/cute-cat.png」。

保存设置后,再次使用插件添加注释时,就会使用你自定义的注释图形了。

骚而不扰

虽然骚注释可以给我们的代码增添趣味性,但也要注意不要骚过头。

在使用骚注释时,要考虑以下几点:

  • 不要滥用骚注释。 过多的骚注释会让代码变得杂乱无章,影响可读性。
  • 骚注释不要影响代码功能。 骚注释应该只是一种装饰,不要影响代码的正常运行。
  • 尊重团队规范。 如果团队中有明确的注释规范,请遵循团队规范,不要使用骚注释。

骚出新高度

除了使用骚注释外,还可以通过其他方式骚出新高度:

  • 骚变量名。 比如,将「变量」命名为「变量小可爱」。
  • 骚函数名。 比如,将「计算函数」命名为「计算小能手」。
  • 骚注释。 除了骚注释图形,还可以写一些骚气十足的注释内容。

只要不影响代码功能,尽情发挥你的骚气吧!

骚注释清单: