在前端开发中，代码的质量和规范非常重要。为了保证代码的质量和避免随意操纵代码的坏习惯，我们需要使用代码检查工具。其中，eslint 是目前前端领域中比较流行的一种代码检查工具。
本文主要介绍一款基于 eslint 的 npm 包: eslint-config-standard-jsdoc，它可以帮助开发者做好代码规范上的控制，从而保证代码的逻辑和清晰度。
简介
eslint-config-standard-jsdoc 是一个 eslint 的配置包。它是在 eslint-config-standard 的基础上增加了对 JSDoc 注释的检查。它采用了一种类似于 Google JSDoc 的注释格式，可以帮助开发者提高代码的可读性和维护性。
安装
首先，确保你已经安装了 eslint。如果还没有安装，可以使用以下命令进行安装：
npm install eslint --save-dev
然后，通过 npm 安装 eslint-config-standard-jsdoc：
npm install eslint-config-standard-jsdoc --save-dev
使用
在安装完 eslint-config-standard-jsdoc 之后，你需要将它添加到你的 eslintrc 配置文件中。在这里，我们假设您已创建了一个名为 .eslintrc.js 的文件。在这个文件中，您可以这样配置：
module.exports = {
extends: [
'standard-jsdoc'
]
}这样，就可以使用我们的 eslint-config-standard-jsdoc 配置来检查您的代码了。
配置项
这里列出了 eslint-config-standard-jsdoc 的一些常用配置项：
"require-jsdoc": [2, {"require": {"FunctionDeclaration": true, "MethodDefinition": true, "ClassDeclaration": true}}]：强制所有函数和方法都要有 JSDoc 注释。"valid-jsdoc": [2, {"requireParamDescription": false, "requireReturnDescription": true, "requireReturnType": true}]：JSDoc 注释必须包含返回值类型，但是参数说明可以不写。
完整的配置文件样例：
-- -------------------- ---- -------
-------------- - -
-------- -
----------------
--
------ -
---------------- --- ----------- ----------------------- ----- ------------------- --------
-------------- --- ---------------------------- ----- -------------------- ------
-
-示例代码
接下来，我们来看一段示例代码，这个示例是一个计算长方形面积的函数：
-- -------------------- ---- ------- --- - --------- --- ---- -- - --------- - ------ -------- ----- - --- ----- -- --- --------- - ------ -------- ------ - --- ------ -- --- --------- - -------- -------- --- ---- -- --- --------- -- -------- ---------------------- ------- ------- - ------ ----- - ------ - -------------------------- -- -- ------- --
在上面的代码中，我们使用了 eslint-config-standard-jsdoc 的注释风格。通过这种注释格式，我们可以清楚地了解这个函数的作用和输入输出。同时，因为我们在 .eslintrc.js 中开启了 JSDoc 注释检查，我们不会忘记在代码中添加这些必要的注释，从而提高了代码的可读性和维护性。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedb4bfb5cbfe1ea061135d