You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

VS Code中如何禁用JSX/React代码注释的格式化功能?

哈哈,这个坑我踩过!在VS Code里写React/JSX时,格式化代码把注释排版得乱七八糟确实烦。要让注释保持原样,得看你用的是哪款格式化工具,下面分几种最常见的情况给你解决办法:

1. 用Prettier(React项目最常用的格式化工具)

Prettier默认会对注释做格式化,要让它“放过”注释,有两种方式:

全局配置(所有项目生效)

  1. 打开VS Code设置快捷键:Ctrl+,(Windows/Linux)或Cmd+,(Mac)
  2. 点击右上角的{}图标打开Settings(JSON)
  3. 添加以下配置:
// 禁止Prettier格式化注释
"prettier.formatComments": false,
// 可选:调整代码换行宽度,避免长注释被强制拆分
"prettier.printWidth": 120,
// 可选:保持单行注释的原有缩进(如果需要)
"prettier.singleQuote": true

局部忽略特定注释

如果只想让某一段注释不被格式化,直接在注释上方加/* prettier-ignore */标记:

/* prettier-ignore */
// 我这个注释想怎么写就怎么写,格式化后完全不变
const App = () => {
  return <div>Hello React</div>;
};
2. 用ESLint结合格式化功能

如果你的项目是用ESLint做代码检查兼格式化,需要在ESLint配置里调整规则:

  1. 打开项目根目录的.eslintrc.js(或.eslintrc.json)
  2. 在rules里添加:
"rules": {
  // 禁止Prettier插件格式化注释
  "prettier/prettier": ["error", { "formatComments": false }],
  // 关闭ESLint对注释空格的检查(如果不需要统一注释格式)
  "spaced-comment": "off"
}
3. 用VS Code自带的JS/TS格式化工具

如果你没装第三方格式化插件,用的是VS Code原生的格式化功能,这么设置:

  1. 打开Settings(JSON)(方法同上)
  2. 添加以下配置:
// 忽略JavaScript文件的注释格式化
"javascript.format.comments": "ignore",
// 忽略TypeScript/JSX文件的注释格式化
"typescript.format.comments": "ignore",
// 可选:调整换行宽度,避免注释被强制换行
"javascript.format.printWidth": 120,
"typescript.format.printWidth": 120

最后提醒一下:修改配置后,记得重启VS Code或者重新加载窗口(Ctrl+Shift+P输入Reload Window),确保配置生效哦!

内容的提问来源于stack exchange,提问作者Fullhdpixel

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.05.27 03:35:55