提升代码可读性的VSCode精简纠错规则推荐

星枫同学_2694

星枫同学_2694

2026-09-11

115人浏览

原创

eslint + prettier + better comments 是当前最轻量、最有效、最无痛的 js/ts 项目可读性提升组合,无需配置即可开箱即用;eslint 暴露语义模糊点,prettier 专注格式统一,better comments 通过符号识别强化注释可读性。

提升代码可读性的vscode精简纠错规则推荐

直接说结论:ESLint + Prettier + Better Comments 是当前最轻量、最有效、最无痛的 JS/TS 项目可读性提升组合,不需要写一行配置就能开箱即用。

为什么 ESLint 不只是报红波浪线

很多人看到 no-unused-varsno-shadow 报错就关掉规则,其实这些恰恰是可读性杀手。比如函数参数名和外层变量同名,肉眼难辨作用域;又比如声明了 tempData 却没用,后续阅读者会下意识猜测“它是不是漏写了调用”。ESLint 的价值在于提前暴露这类语义模糊点,而不是单纯卡语法。

实操建议:

  • 必须开启 "editor.codeActionsOnSave": { "source.fixAll.eslint": true },否则每次修复都要手动点灯泡
  • 别直接用 eslint:recommended,它默认禁用 no-console,而残留的 console.log 是团队代码里最常见的可读性污染源
  • 如果项目没有 .eslintrc.js,新建一个,内容只需三行:
    module.exports = {
      extends: ["eslint:recommended"],
      rules: {"no-console": "warn"}
    };

Prettier 和 ESLint 共存时最常踩的坑

两者规则打架会导致保存后代码反复跳动:分号一会儿加一会儿删,空格一会儿多一会儿少。这不是插件问题,而是配置缺失。

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载

实操建议:

  • 必须安装 eslint-config-prettier,它会关闭 ESLint 中所有与格式相关的规则,让 Prettier 全权负责
  • VS Code 设置里务必关掉 editor.formatOnType,否则打字中途自动格式化会打断思路
  • 关键 Prettier 配置只设三项:prettier.singleQuote(推荐 true)、prettier.semi(推荐 false)、prettier.printWidth(推荐 100

Better Comments 注释染色不生效?检查这三点

装完插件发现注释还是全灰,大概率是符号识别失败。它不解析内容,只靠开头字符匹配,对空格和位置很敏感。

实操建议:

  • 别写 // TODO:,改用 // !TODO:// ?Why:,开头必须是 !?* 等支持符号
  • // !//! 效果一样,但 // !(带空格)更稳定,避免被误判为注释内容的一部分
  • 真正容易被忽略的是注释与代码的耦合度——很多 // ! 注释写完就没再更新,等函数逻辑变了,注释反而误导人

复杂点在于:可读性不是靠堆插件实现的,而是靠规则之间不互相干扰、提示信息不自相矛盾、以及注释始终随代码演进。一旦某条规则开始让人“习惯性右键忽略”,它就已经在损害可读性了。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
vscode是什么_vscode怎么安装配置
vscode是什么_vscode怎么安装配置

VS Code(Visual Studio Code)是一款免费、开源的跨平台代码编辑器,由微软开发和维护。它被广泛用于软件开发和编程,支持多种编程语言和框架。VS Code 同时提供了丰富的功能和扩展性,使开发者可以高效地编写、编辑和调试代码。

2023.06.30

1135

18

vscode怎么运行代码
vscode怎么运行代码

vscode是一个运行于MacOS X、Windows和Linux之上的,针对于编写现代Web和云应用的跨平台源代码编辑器;vscode免费而且功能强大,对JavaScript和NodeJS的支持非常好,自带很多功能,例如代码格式化,代码智能提示补全、Emmet插件等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.21

2232

3

vscode使用的框架介绍
vscode使用的框架介绍

VSCode是一款跨平台代码编辑器,它基于Electron框架和Monaco Editor构建。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1789

12

vscode一般用来写什么语言
vscode一般用来写什么语言

VSCode是一款功能强大的代码编辑器,支持多种编程语言和文件格式。它内置对 JavaScript、Python、Java、C++、TypeScript、HTML/CSS、Go 等语言的支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1587

8

vscode可以写什么语言
vscode可以写什么语言

vscode是一款强大的代码编辑器,支持多种编程语言的开发。通过安装扩展,可以为 JavaScript/TypeScript、Python、Java、C#、PHP、Go、Ruby、Rust、HTML/CSS 等语言提供智能代码补全、调试和格式化等功能。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

2467

12

vscode中文设置方法
vscode中文设置方法

方法一:在设置页面中,搜索“locale”,并选择“zh-cn”。方法二:按“Ctrl Shift P”快捷键,输入“Configure Display Language”,将语言修改为“zh-cn”。如果上述方法无效,可考虑安装中文插件。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1738

14

vscode用途介绍
vscode用途介绍

Visual Studio Code(VSCode)是一款由 Microsoft 开发的多功能文本编辑器,适用于各种编程语言。作为一款开源软件,VSCode 拥有代码高亮、自动补全、调试、Git 集成等强大功能,成为程序员不可或缺的工具。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1202

10

vscode和visualstudio的区别
vscode和visualstudio的区别

Visual Studio是一款功能强大的集成开发环境(IDE),适用于专业开发人员进行复杂项目的构建。而VSCode则是一款轻量级的代码编辑器,更适合各种规模的项目开发。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1076

8

vscode设置中文界面不生效解决方法
vscode设置中文界面不生效解决方法

vscode设置中文界面不生效解决方法:安装中文语言包、通过命令面板设置语言、检查 locale.json 设置、重新安装中文语言包、检查 VSCode 版本和更新、排除插件冲突、检查系统语言设置、查看 VSCode 日志和错误消息、重置 VSCode 设置、查看官方文档和社区支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

394

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程