npm 包 crojsdoc-plugin-underscore-private 使用教程

前言

在前端开发中，我们都知道文档编写和注释是十分重要的。而文档在编写的时候，难免会遇到一些需要隐藏不对外公开的方法或者属性，这时候，我们就需要使用 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 安装

  1. 安装 crojsdoc-plugin-underscore-private：
--- ------- ---------- ----------------------------------
  1. 在 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

阅读全文

猜你喜欢

  • npm 包 runup-lean 使用教程

    在前端开发中，我们通常需要使用一些工具来增强我们的开发效率。runup-lean 是一个 npm 包，它可以帮助我们更快速地搭建 react 项目。本文将介绍 runup-lean 的使用方法，从而让...

    5 年前
  • npm 包 githubdocs 使用教程

    前言 如果你是一名前端开发人员，相信你已经听过或使用过 npm。npm 是 Node.js 的包管理器，它是世界上最大的软件注册表之一。在这个社区中，有数以百万计的包可以使用。

    5 年前
  • npm 包 system-registry 使用教程

    简介 Node.js 中的 npm 包管理工具是前端开发中不可或缺的一部分，可以方便地管理项目中使用的第三方库或工具。而 system-registry 这个 npm 包则可以帮助我们更好地管理全局安...

    5 年前
  • NPM 包 box-js 使用教程

    什么是 box-js? box-js 是一个使用 JavaScript 实现的沙箱环境，它可以对 JavaScript 代码进行解析和执行，同时能够监控 JavaScript 代码的行为，从而实现对恶...

    5 年前
  • npm 包 express-uglify2 使用教程

    在前端开发中，往往需要对 JavaScript 代码进行压缩以提升网站的性能和加载速度。而在 Node.js 中，我们可以使用 npm 包 express-uglify2 来压缩 JavaScript...

    5 年前
  • npm 包 is-git-repository 使用教程

    在前端开发中，我们经常需要对代码进行版本控制，而 Git 是其中最常用的工具之一。在使用 Git 时，有时我们需要检测当前的目录是否是一个 Git 仓库，这时就可以使用 npm 包 is-git-re...

    5 年前
  • npm 包 current-git-branch 使用教程

    在前端开发过程中，当前使用的 Git 分支是一个非常重要的信息。然而在快速迭代的开发中，我们可能会经常切换 Git 分支，忘记当前使用的是哪个分支。于是我们需要一个简单的工具来获取当前使用的 Git ...

    5 年前
  • npm 包 paqman 使用教程

    前言 在前端开发中，随着项目越来越庞大，依赖的第三方库越来越多，使得包管理工具变得越来越重要。npm 就是一款非常优秀且流行的包管理工具，能够很好地帮助我们管理项目中的依赖项。

    5 年前
  • npm 包 nf-conventional-changelog 使用教程

    介绍 nf-conventional-changelog 是一个 npm 包，它为项目自动生成具有规范性的 changelog。其基于 Conventional Commits 标准，它提供了一个规范...

    5 年前
  • npm包`eslint-config-netflix`使用教程

    在前端开发中，使用静态代码分析工具可以帮助开发者在开发时更加规范、高效、准确地编写代码。而eslint就是这样一款常用的静态代码分析工具，可以检查并修复代码中的潜在错误和不规范的写法。

    5 年前
  • npm 包 unleash 使用教程

    什么是 npm 包 unleash？ npm 包 unleash 是一个功能强大的功能开关管理库，可以帮助开发人员动态的控制应用程序或特定功能的行为。它提供了许多高级的功能来管理功能开关，例如分布式控...

    5 年前
  • NPM 包 minify-hex-code 使用教程

    在 Web 前端开发的过程中，我们经常需要对 CSS、HTML、JavaScript 或者其他类型的文件进行压缩和优化，以提高加载速度和用户体验。而其中的一种优化手段就是使用十六进制颜色值来代替 RG...

    5 年前
  • npm 包：uglifyjs-webpack-plugin2 使用教程

    介绍 uglifyjs-webpack-plugin2 是一个与 Webpack 集成的 JavaScript 压缩插件。使用它，我们可以在打包时自动压缩 JavaScript 代码，提高网站的加载速...

    5 年前
  • npm 包 tic80-typescript 使用教程

    tic80-typescript 是一个 TypeScript 类型定义库，专为小型游戏开发而设计。本文将详细介绍如何使用该工具包及其相关特性。 安装 tic80-typescript 要使用 tic...

    5 年前
  • npm 包 json-stringify-extended 使用教程

    简介 json-stringify-extended 是一款能够将 JSON 对象转换成字符串的 npm 包，支持定制化配置，比原生的 JSON.stringify 更加灵活。

    5 年前
  • npm 包 jdf-ws 使用教程

    前言 在前端开发中，我们经常需要与后端进行接口交互，而 jdf-ws 是一个非常方便的 npm 包，可以帮助我们处理各种 HTTP 请求。本文将详细介绍 jdf-ws 的使用方法，帮助读者更好地理解其...

    5 年前
  • npm 包 simple-prompt 使用教程

    在前端开发中，有时候我们需要在命令行中与用户进行交互。简化用户输入和输出的过程是很必要的，而 npm 包 simple-prompt 恰好提供了这样的解决方案。简单、易用、可定制，是 simple-p...

    5 年前
  • npm 包 jdf-copy 使用教程

    前言 随着前端开发的不断发展，我们所接触的项目也变得越来越复杂。在这样的情况下，如何提高我们的工作效率和减少出错的概率变得尤为重要。其中，一个让我们事半功倍的好帮手就是 jdf-copy。

    5 年前
  • npm 包 tle.js 使用教程

    前言 在前端开发中，算法题和数据结构是很重要的一部分。但是在做算法题和数据结构题目时，重点是什么？时间复杂度，空间复杂度，还有测试用例。 其中，时间复杂度是最能反映算法运行效率的指标，也是判断算法优越...

    5 年前
  • npm 包 element-resize-event 使用教程

    在开发前端应用时，经常会遇到需要监听 DOM 元素的大小调整事件，以做出相应的响应。这时可以使用一个轻量级的 npm 包：element-resize-event。

    5 年前

相关推荐

    暂无文章