Atom怎么检测代码注释规范

老静吖_3335

老静吖_3335

2026-10-20

430人浏览

原创

atom不检查jsdoc规范,需依赖eslint-plugin-jsdoc插件并正确配置plugins、rules及parser;未安装插件、未注册、未启用规则或文件未被识别为js/ts,注释即被忽略。

atom怎么检测代码注释规范

Atom 本身不检测注释规范,所有检查都依赖 ESLint + eslint-plugin-jsdoc 或类似插件;没配规则、没装插件、没启用对应 processor,就只会当普通文本处理,连“缺少 JSDoc”都不会报。

为什么写了 JSDoc 还是没警告?

ESLint 默认完全忽略注释内容,eslint-plugin-jsdoc 必须显式启用,且需在 .eslintrc.js 中配置 plugins 和 rules,否则注释就是透明的。

  • 没装插件:npm install eslint-plugin-jsdoc --save-dev,只装 ESLint 本体没用
  • 没注册插件:配置里漏了 plugins: ["jsdoc"]
  • 没开规则:比如 "jsdoc/require-jsdoc": "error" 没写,或写成 "jsdoc/require-jsdoc": 0
  • 文件没被识别为 JS/TS:右下角显示 Plain text 或 text.html.vue,linter-eslint 直接跳过

如何让 ESLint 检查函数注释是否完整?

关键不是加插件,而是选对规则并适配项目语言。JS 和 TS 的 parser、plugin 配置不能混用,否则规则压根不触发。

Glean
Glean

一款面向企业知识管理与工作场景的 AI 平台,将企业内部搜索、知识问答、数据分析和智能协作能力连接到日常办公流程中。

下载
  • JS 项目:确保 parserOptions.ecmaVersion ≥ 2015(支持 class、箭头函数等)
  • TS 项目:必须配 parser: "@typescript-eslint/parser" 和 plugins: ["@typescript-eslint", "jsdoc"]
  • 常用规则示例:"jsdoc/require-jsdoc": ["error", { "publicOnly": true }] 只检查导出函数
  • 忽略测试文件:在 overrides 里加 files: ["**/*.test.js"], rules: {"jsdoc/require-jsdoc": "off"}

Vue 单文件组件里的 <script></script> 注释怎么检查?

ESLint 默认把 .vue 当 HTML 处理,<script></script> 块根本不会进 JS 解析流程——不配 processor,JSDoc 就是空气。

  • 必须启用 Lint HTML Files(在 linter-eslint 设置页勾选)
  • 必须安装 eslint-plugin-vue 和 eslint-plugin-html
  • .eslintrc.js 中 overrides 要明确指定 processor: "vue/vue",否则 jsdoc/* 规则不生效
  • 示例片段:
    overrides: [{ files: ["*.vue"], processor: "vue/vue", rules: { "jsdoc/require-jsdoc": "error" } }]

注释规范检查容易被忽略的硬性前提

所有 JSDoc 规则都建立在“代码能被正确解析”的基础上。如果 parser 报错(比如用了 as const 却没配 TS parser),ESLint 会直接放弃整块代码的规则检查,包括注释。

  • 先确认控制台有没有 Failed to load parser 或 Cannot read property 'visitNode' of undefined
  • 检查当前文件 grammar 是否为 source.js 或 source.ts(Ctrl+Shift+P → Grammar: Show Grammar)
  • 禁用所有非必要 linter 插件(如 linter-tslint),避免 parser 冲突
  • jsdoc/check-alignment 等格式类规则对缩进敏感,若文件缩进混乱(空格/Tab 混用),可能批量误报

相关文章

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

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

下载

相关标签:

atom代码注释

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

相关专题

更多
c语言编程软件有哪些
c语言编程软件有哪些

c语言编程软件有GCC、Clang、Microsoft Visual Studio、Eclipse、NetBeans、Dev-C++、Code::Blocks、KDevelop、Sublime Text和Atom。更多关于c语言编程软件的问题详情请看本专题的文章。php中文网欢迎大家前来学习。

2023.11.02

8439

18

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

2026.10.16

80

10

OpenJDK怎么配置Java开发环境
OpenJDK怎么配置Java开发环境

怎样用OpenJDK搭建开发环境?本专题介绍版本选择、下载安装、环境变量配置和编译运行验证,帮助你理清JDK的作用及基本配置流程,并通过简单程序检查环境是否可用,为后续项目开发做好准备。

2026.10.16

40

10

OpenJDK怎么部署Java应用
OpenJDK怎么部署Java应用

Java项目开发完成后,怎样部署到目标环境并正常运行?本专题介绍OpenJDK应用部署流程,涵盖运行环境准备、版本兼容检查、应用打包、启动参数配置和日志查看,帮助你理清部署前后的操作顺序,减少环境差异造成的运行问题。

2026.10.16

40

10

Revel框架模板渲染与表单验证
Revel框架模板渲染与表单验证

本专题围绕Revel框架视图层开发,介绍模板语法、变量输出、布局复用、表单提交、参数绑定与验证规则,帮助开发者完成安全规范的页面交互。

2026.10.16

20

15

Revel框架MVC路由与控制器
Revel框架MVC路由与控制器

本专题聚焦Revel框架MVC核心机制,讲解路由定义、控制器Action、参数绑定、请求响应和反向路由,并结合常见场景梳理接口请求处理流程。

2026.10.16

20

15

Revel框架入门与安装配置
Revel框架入门与安装配置

本专题从Revel框架环境搭建讲起,系统介绍命令行工具安装、项目创建、目录结构、配置文件及热代码重载,帮助开发者快速完成首个Go Web应用。

2026.10.16

20

15

Linux 新手先学哪些命令
Linux 新手先学哪些命令

Linux新手命令专题汇集终端基础、文件目录操作、文本查看、软件安装和权限管理等入门文章,帮助按实际任务练习常用命令并建立命令行操作习惯。

2026.10.15

40

20

MySQL 忘记密码怎么办
MySQL 忘记密码怎么办

MySQL忘记密码专题汇集不同版本与系统下的root密码重置方法,覆盖MySQL 5.7、8.0、Mac、Linux及本地集成环境,并提示恢复权限与重新登录的检查步骤。

2026.10.15

40

18

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.8万人学习