如何在VS Code中禁用Java代码注释自动格式化功能?
VS Code禁用Java注释格式化方法
方法1:全局关闭所有Java注释格式化
适用于完全不需要自动调整注释格式的场景,针对默认Red Hat Java语言扩展:
- 按
Ctrl+,(Windows/Linux)或Command+,(Mac)打开设置面板 - 点击右上角的「打开设置(JSON)」按钮,进入配置编辑页
- 添加以下配置后保存:
"java.format.comments.enabled": false
重新触发代码格式化后,所有Java注释都会保留原有排版不会被调整。
方法2:局部保留指定内容格式
如果只是个别带对齐格式的注释不想被修改,不需要全局禁用功能,可以用格式化忽略标记包裹对应代码段:
// @formatter:off /** * original: 0, 2, 1, 4, 3, 5, 7, 6 * max: 0, 2, 2, 4, 4, 5, 7, 7 * sorted: 0, 1, 2, 3, 4, 5, 6, 7 * index: 0, 1, 2, 3, 4, 5, 6, 7 * * The chunks are: 0 | 2, 1 | 4, 3 | 5 | 7, 6 * @param arr * @return */ // @formatter:on
格式化工具会自动跳过两个标记之间的所有内容,不会修改原有排版,其余代码的格式化功能不受影响。
方法3:自定义注释格式化规则
如果只需要关闭注释的自动换行、对齐调整,其余代码格式化功能(比如缩进、括号排版)正常使用,可以自定义格式化规则:
- 导出Eclipse格式的Java格式化配置文件(.xml格式),在配置中关闭所有注释格式化相关选项
- 在settings.json中添加配置,指向你本地的配置文件路径即可:
"java.format.settings.url": "file:///本地配置文件路径/java-formatter.xml"
内容的提问来源于stack exchange,提问作者Haifeng Zhang
相关产品推荐
相关产品推荐

