前言
在前端开发中，我们都知道文档编写和注释是十分重要的。而文档在编写的时候，难免会遇到一些需要隐藏不对外公开的方法或者属性，这时候，我们就需要使用 crojsdoc-plugin-underscore-private 这个 npm 包。
本文即将对 crojsdoc-plugin-underscore-private 进行详细介绍和使用教程，并通过示例代码进行解释。
crojsdoc-plugin-underscore-private 简介
crojsdoc-plugin-underscore-private 是一个可以处理文档中易于混淆和难以理解的私有属性和方法的 npm 包。它适用于 crojsdoc 风格的文档注释。
crojsdoc-plugin-underscore-private 能够自动将包含 _ 开头的私有属性和方法从文档中去除，并将它们分别放到一个独立的区域中，这让我们的文档更加干净、简洁。
crojsdoc-plugin-underscore-private 安装
- 安装 crojsdoc-plugin-underscore-private：
npm install --save-dev crojsdoc-plugin-underscore-private
- 在 crojsdoc 配置文件中添加 crojsdoc-plugin-underscore-private 依赖：
在 crojsdoc.json 中添加如下代码：
-- -------------------- ---- -------
-
------- -
-------- -
---------
-------------
-----------
-------
-----------
-------
----------
-
--
---------- -
------------------------------------
-
-crojsdoc-plugin-underscore-private 使用方法
接下来，我们将通过示例代码，演示 crojsdoc-plugin-underscore-private 的使用方法：
-- -------------------- ---- -------
---
- ----- ------------ - ----
- ------
- -------
--
----- --- -
---
- ---------- - ----
- ------------
- -------
- ------ -------- ---- - --- --- -----
- ------ -------- ----- - --- --- ------
- ------ -------- ---- - --- --- ----- -----
--
----------------- ------ ----- -
--------- - -----
---------- - ------
--------- - -----
-
---
- ------ --- ----
- --------
- -------- --------
--
-------- -
------ ------------- ------------- -- ----- ---------
-
---
- ----- --- ----
- --------
- -------- --------
--
------- -
------ ------------- ------------- -- ----------
-
---
- ------ --- ----
- -------
- -------- --------
--
------- -
------ ------------- ------------- -- ----------
-
---
- ------ --- ----- --- ----
- -------
- -------- --------
--
-------------- -
------ ----------------- -----------------
-
-
在上述示例代码中，我们定义了一个 Car 类，它包含了一些公有的方法和私有的方法。在这里，我们使用了 crojsdoc-plugin-underscore-private，使得文档中不会展示私有属性和方法。
通过配置好 crojsdoc.json 文件，在终端运行可以生成文档文件，并且在文档中不会展示私有属性和方法，如下所示：
-- -------------------- ---- -------
--------- -----
------
------
----- ----------------
--------- ------- ---------------------
----- ----------------------------------------------------------------------- -----------------
------ ----------------
---- - ------------ ------- ------ ----------- -
------------------- - ------- ----- -
--------------------- - ---------- ----- -
-------------- - ---------- ----- -
----------------- - ---------- ----- -
------------------- - ---------- ----- -
----------------- - ---------- ----- -
--------
-------
------
---- ---------------------------
--- -----------------
-- ---------------------------------- ------------ - --------
---------------- --- -
--------------
--- ------------------------------------
-- -------------------------------- -----------
------------------------------- - -------- -- -
------ ------------- ------------- -- ----- ---------
---------------
--- ----------------------------------
-- -------------------------------- -----------
------------------------------ - -------- -- -
------ ------------- ------------- -- ----------
---------------
--- ------------------------------------
-- ----------------------------------- --- --------
-- ------------------------------ -----------------------
------------------------------ - -------- -- -
------ ------------- ------------- -- ----------
---------------
--- --------------------------------------------------
-- ----------------------------------- --- ----- --- --------
-- ------------------------------ -----------------------
------------------------------------- - -------- -- -
------ ----------------- -----------------
---------------
------
------- ------------------------
-------
-------结论
在本文中，我们介绍了 crojsdoc-plugin-underscore-private 这个 npm 包的详细使用方法。它让我们能够更加方便地隐藏文档中的私有属性和方法，使得我们的文档更加干净、简洁。我们相信通过本文的介绍和示例代码的演示，你已经掌握了这个 npm 包的使用方法，也可以在工作中使用它来散发出更优秀的文档。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/64400