npm install --save-dev eslint-plugin-jsdoc Configuration Flat config importjsdocfrom'eslint-plugin-jsdoc';constconfig=[// configuration included in pluginjsdoc.configs['flat/recommended'],// other configuration
eslint-plugin-jsdoc是一款用于检查和优化JSDoc注释质量的ESLint插件。通过集成到你的ESLint配置中,它可以实时检测并提醒潜在的问题,比如缺失的描述、错误的类型声明或不一致的参数名等。这款工具支持多种规则和自定义配置,以适应不同的项目需求和编码风格。 技术分析 eslint-plugin-jsdoc利用了ESLint的强大功能,提...
export default [ { files: ["**/*.js"], languageOptions: { sourceType: "script" } } ]; # 配置自定义解析器及其选项在许多情况下,您可以使用 ESLint 附带的默认解析器来解析您的 JavaScript 代码。您可以选择使用 parser 属性覆盖默认解析器。parser 属性可以是 "pluginName/parserName" 格式的字符串...
jsdoc/check-types https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-types.md#repos-sticky-header jsdoc/check-values https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-values.md#repos-sticky-header ✨ jsdoc/empty-tags https://github.com/gajus...
https://github.com/gajus/eslint-plugin-jsdoc 安装Eslint之后安装插件 npminstall--save-dev eslint-plugin-jsdoc 安装结束在Eslint配置文件中添加 importjsdocfrom'eslint-plugin-jsdoc'; exportdefault{ {"rules":{ } }, {"plugins": { jsdoc },"rules": {//在这里添加对应的配置规则插件的规则开头...
确认插件是否正确安装:首先需要确认Eslint和Jsdoc插件是否已经正确安装。可以通过在终端中运行相关命令来安装插件,例如使用npm安装:npm install eslint-plugin-jsdoc --save-dev。 配置Eslint配置文件:在项目根目录下找到.eslintrc文件(或者其他命名为.eslintrc.js、.eslintrc.json等的文件),确保已经正确配置了Jsdo...
自己常用配置: module.exports ={ root:true, env: {/** * 规则适用*/browser:true, node:true, commonjs:true, es6:true, amd:true},'extends': ['plugin:vue/essential','@vue/standard'], rules: {/** * 运行环境*/'no-console': process.env.NODE_ENV === 'production' ? 'error' : 'of...
cnpm install babel-eslint eslint-plugin-react eslint-plugin-import --save-dev 1. 5. .eslintrc.js文件其他配置: module.exports = { "env": { "browser": true, "commonjs": true, "es6": true }, "parser": "babel-eslint", "extends": [ ...
{ "name": "testcase", "version": "1.0.0", "dependencies": { "eslint": "9.5.0", "eslint-plugin-jsdoc": "48.2.13" } } eslint.config.mjs import jsdoc from "eslint-plugin-jsdoc"; export default [ { plugins: { jsdoc }, rules: { "jsdoc/no-undefined-types": "error" } ...
`eslint-plugin-jsdoc` 插件的主要作用是检查代码是否遵循了 JSDoc 规范。具体来说,它会检查代码中的注释是否符合以下规则: 1. 注释必须以 `/` 开头,并以 `/` 结尾。 2. 注释中的描述信息(即注释的内容)必须放在两个 `` 之间。 3. 注释中的参数名必须用双引号括起来,参数名后面必须跟有空格和冒号。