VS Code中如何设置块注释分隔符单独占一行？

问题场景 #

使用VS Code快捷键Shift + Alt + A给选中代码添加块注释时，生成的格式是分隔符与代码同行：

/* console.log("...");
console.log("...");
console.log("..."); */

期望实现的格式是/*和*/各自单独占一行：

/*
console.log("...");
console.log("...");
console.log("..."); 
*/

解决方案 #

1. 配置语言特定的注释规则

打开VS Code的settings.json（快捷键Ctrl + Shift + P，输入Open Settings (JSON)），添加对应语言的注释配置（以JavaScript为例）：

"[javascript]": {
  "editor.comment.blockComment": ["/*\n", "\n */"]
}

该配置会让块注释的起始符自动换行，结束符也单独占一行。

2. 配合格式化工具调整（如Prettier）

如果使用Prettier作为代码格式化工具，在项目根目录的.prettierrc文件中添加以下配置：

{
  "commentBlockLineThreshold": 1
}

当注释块包含1行及以上代码时，Prettier会自动将/*和*/单独换行。开启editor.formatOnSave后，保存代码时就会自动调整注释格式。

3. 自定义快捷键覆盖默认行为

如果上述方法不生效，可以直接自定义快捷键来生成目标格式：

1. 打开键盘快捷方式设置（Ctrl + K Ctrl + S），点击右上角的打开JSON按钮；
2. 添加以下配置，覆盖默认的Shift + Alt + A快捷键：

{
  "key": "shift+alt+a",
  "command": "editor.action.insertSnippet",
  "when": "editorTextFocus && !editorReadonly",
  "args": {
    "snippet": "/*\n$TM_SELECTED_TEXT\n */"
  }
}

选中代码后按下Shift + Alt + A，就会直接生成符合要求的块注释格式。

内容的提问来源于stack exchange，提问作者Henry Mueller