什么是 jsdoc-autoprivate
jsdoc-autoprivate 是一个 npm 包，它可以自动生成 JavaScript 代码中的私有属性和方法的 JSDoc。
JSDoc 是一种用于 JavaScript 代码的文档注释风格，它可以帮助开发者理解代码的含义，以及使用方式。但是 JSDoc 并不支持私有属性和方法的注释，而 jsdoc-autoprivate 就是为了解决这个问题而生的。
jsdoc-autoprivate 可以自动将 JavaScript 代码中的私有属性和方法转换为公有属性和方法，并生成相应的 JSDoc 注释。
如何安装 jsdoc-autoprivate
你可以使用 npm 命令行工具来安装 jsdoc-autoprivate：
$ npm install jsdoc-autoprivate --save-dev
如何使用 jsdoc-autoprivate
使用 jsdoc-autoprivate 的方法非常简单，你只需要在命令行中执行以下命令：
$ jsdoc-autoprivate path/to/file.js
其中，path/to/file.js 是你想要处理的 JavaScript 文件的路径。执行完这个命令之后，jsdoc-autoprivate 就会自动将私有属性和方法转换为公有属性和方法，并生成相应的 JSDoc 注释。
示例代码
以下是示例代码，它演示了如何使用 jsdoc-autoprivate：
-- -------------------- ---- -------
---
- ------ -------
- ---------- ---- -- -- ------
- --------
--
-------- --------- -
---
- --------
- ----- --------
--
--- --------------- - ---
---
- --------
- ------- ---------------
- ----- ---- -- -- ------- -------
- ------ -------- - - - ------ -- ----
- -------- -------- --- --- -- --- ------ --- ----------------
--
-------- ------------------ -
------ --------------- - --
-
---
- ------- --------------
- ----- ---- -- -- ------ -------
- ------ -------- - - - ------ -- ----
- -------- -------- --- --- -- --- ------ --- ----------------
--
------------------- - ----------- -
------ -------------------
--
-执行以下命令：
$ jsdoc-autoprivate MyClass.js
执行完命令之后，得到的代码如下：
-- -------------------- ---- -------
---
- ------ -------
- ---------- ---- -- -- ------
- --------- -------- --------------- ---- -- -- ------- -------
--
-------- --------- -
---
- --------
- ----- --------
- ----- ---- -- -- ------- -------
--
-------------------- - ---
---
- --------
- ------- ---------------
- ----- ---- -- -- ------- -------
- ------ -------- - - - ------ -- ----
- -------- -------- --- --- -- --- ------ --- ----------------
--
-------- ------------------ -
------ -------------------- - --
-
---
- ------- --------------
- ----- ---- -- -- ------ -------
- ------ -------- - - - ------ -- ----
- -------- -------- --- --- -- --- ------ --- ----------------
--
------------------- - ----------- -
------ -------------------
--
-可以看到，jsdoc-autoprivate 已经自动将私有属性和方法转换为了公有属性和方法，并生成了相应的 JSDoc 注释。现在，这个代码就可以被更好地文档化了。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedcad8b5cbfe1ea06124c7