npm 包@jeremyckahn/minami 使用教程

AI 编程助手，豆包旗下的编程助手，提供智能补全、智能预测、智能问答等能力，节省开发时间，释放脑海中的创造力，支持 VSCode，点击体验 AI

介绍

@jeremyckahn/minami 是一个简约的 JSDoc 主题，具有优美的排版和易用性，支持自定义样式和字体的个性化定制。使用它可以极大地提高代码文档的可读性和美观度。

安装

安装 minami 主题只需要通过 npm 把它安装到你的项目中即可。

--- ------- ---------- -------------------

使用

配置 JSDoc

在你的项目中增加一个 doc 目录，然后在目录中创建一个配置文件 jsdoc.json。

-
  ---------- ---------------------
  --------------- ---
  --------- -
    ---------- -
      ------
      -----------
    --
    ---------- -
      --------------
    --
    ----------------- -------------
    ----------------- ---------------
  --
  ------------- ---------
  ------- -
    ------------------- -----
    --------------- -
      --------
      ---------
    -
  --
  ------- -
    -------------- --------
    ----------- ------------------------------------
  --
  ------------ -
    ------------------ --- -----
    -------------- --- --- -----
  -
-

运行 JSDoc

通过命令行来运行 JSDoc，从而生成文档。

------------------------- ----------- ----------------

自定义样式

如果你想自定义主题的样式，并覆盖默认配置，只需要在项目的 jsdoc.json 文件中添加样式选项即可。

-
  ------- -
    -------------- --------
    ----------- -------------------------------------
    ------------ ------------------------
    --------- -
      --------- -----------
      ---------- -----------
      -------- -
        ------------ --------- ---- ------
        -------------- --------- ---- ------
        --------- --------- ---- ------
        ------- -------- --- -----
        ------- --------- ---- -----
        ------------ --------- ---- ------
        -------------- -------- --- -----
        -------------- -------- ---- ------
        -------------------- --------- ---- -----
        --------------- ----------
        ------------------ ------- -- ----
        --------- --------- ---- ------
        ------------ -------- --- -----
        ---------- -------- --- -----
        ---------- -------- --- -----
        ---------- -------- --- -----
        ---------- -------- --- -----
        ---------- -------- --- -----
        ---------- -------- --- -----
        ------------ -- --- ---- ------- -- -- ------
        --------------------- ---------
      -
    -
  -
-

其中，minami 是自定义的配置项，下面的样式可以按照自己的需要进行定制。

示例代码

建议在代码中使用 JSDoc 注释。

---
 - ---------- - -----
 - ------------
 - ------ -------- ----- - --- ----- -- --- -----
 - ------ -------- ------ - --- ------ -- --- -----
 --
-------- ----------- ------- -
  ---------- - ------
  ----------- - -------

  ---
   - ---- --- ----- -- --- -----
   - -------- --------
   --
  ------------- - ---------- -
    ------ -----------
  --
-

-- ----
--- ------ - --- ----------- -------- ----- ----------

-------------------------------

结尾

使用 @jeremyckahn/minami 主题可以从代码文档化的角度着手，提高前端应用的可维护性和可读性。同时，在个性化样式和配置上也可以根据项目特点进行灵活调整。

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/5eedaf67b5cbfe1ea061101c

阅读全文

猜你喜欢

  • npm 包 vscode-web-custom-data 使用教程

    简介 vscode-web-custom-data 是一个基于 JSON Schema 的规范与 VS Code 扩展支持的 Web 各类开发语言（比如 HTML、CSS、JavaScript）的智能...

    4 年前
  • npm 包 vscode-html-languageservice 使用教程

    简介 vscode-html-languageservice 是一个基于 VS Code 项目的 HTML 语言服务，它提供了与 HTML 相关的语法解析、代码智能提示、高亮显示、代码格式化、错误检查...

    4 年前
  • npm 包 nuget-in-path 使用教程

    在前端开发中，我们需要使用很多第三方库和框架，这些库和框架的管理以及与代码的集成，就需要借助包管理工具。npm 是前端流行的包管理工具之一，它提供了丰富的包和模块，能够极大提高前端开发效率。

    4 年前
  • npm 包 @popperjs/babel-config 使用教程

    简介 @popperjs/babel-config 是 @popperjs/core 的一个依赖项，它提供了适用于 popper.js 项目的 babel 配置。在项目中，可以通过引用此依赖项，轻松定...

    4 年前
  • npm 包 tachyons-custom 使用教程

    前言 在前端开发中，UI 样式是我们必须要处理的一个重要问题，而 tachyons-custom 是一个非常优秀的样式开发库。它以可复用和可扩展性为核心，提供了一系列的基本样式类，可以帮助我们快速开发...

    4 年前
  • npm 包 css-scss 使用教程

    什么是 css-scss？ css-scss 是一个 npm 包，可以将 SCSS 或 Sass 文件转换为 CSS 格式的文件。它包含了多种将 SCSS 或 Sass 文件编译为 CSS 的方法，比...

    4 年前
  • npm 包 rat 使用教程

    介绍 rat 是一个基于 Node.js 的命令行工具，可以帮助开发者快速创建项目或添加一些常用的文件或代码块。在前端开发中，rat 包含了许多常用的模板和配置，可以节省开发者的时间并提高工作效率。

    4 年前
  • NPM 包 Capture-stdout 使用教程

    前言 在日常前端工作中，我们常常需要查看运行时的日志。这对于定位异常问题非常重要。然而在某些情况下，我们并不方便直接查看运行日志，因为有的日志是打印在终端中、有的日志是记录在文件中、有的日志还可能是被...

    4 年前
  • npm 包 sonar-scanner 使用教程

    什么是 sonar-scanner? sonar-scanner 是一个开源的代码质量评估工具，它可以帮助开发者在项目开发过程中，自动检测代码中的错误、漏洞和弱点，并提供相应的修复建议和质量评估报告。

    4 年前
  • npm 包 stryker-cli 使用教程

    在前端开发中，测试是非常重要的环节，它帮助我们发现代码中的问题，保证代码的质量和可靠性。而 stryker-cli 就是一款非常实用的测试工具，能够帮助我们对 JavaScript 代码进行自动化测试...

    4 年前
  • npm 包 spider.js 使用教程

    今天我们来介绍一个前端类的 npm 包 - Spider.js，该包可以帮助我们快速地抓取网页数据，非常实用。在这篇文章中，我们将会介绍 Spider.js 的使用教程、实例代码，以及其对我们的深度学...

    4 年前
  • npm 包 @types/lodash.range 使用教程

    在前端开发中，经常需要对数据进行数字范围的操作，而 lodash.range 就是一个非常实用的工具库。但是，当我们在 TypeScript 项目中使用 lodash.range 时，会发现编译会报错...

    4 年前
  • npm 包 @lrowe/eslint-plugin-flow-remove-types 使用教程

    随着前端技术的不断发展，越来越多的项目已经开始使用 flowType 进行类型检查，这是一个非常好的做法，可以避免很多变量类型不正确导致的错误。但是，对于已经存在的项目或者一些第三方库来说，增加类型检...

    4 年前
  • npm 包 php-server 使用教程

    简介 php-server 是一个基于 Node.js 的 npm 包，用于在本地搭建 PHP 环境的服务器。它可以帮助前端开发者在本地快速搭建一个 PHP 环境，方便调试和开发。

    4 年前
  • npm 包 karma-safarinative-launcher 使用教程

    karma-safarinative-launcher 是一款针对 Safari 浏览器的 Karma 浏览器启动器。本篇文章将介绍如何使用该工具，以及如何在前端项目中进行自动化测试。

    4 年前
  • npm 包 grunt-release-it 使用教程

    介绍 在前端开发过程中，自动化构建是非常常见的一项工作。而在进行自动化构建的过程中，经常需要将代码发布到测试环境或生产环境。因此，自动化发布代码是前端开发中一项非常重要的任务。

    4 年前
  • npm 包 fontisto 使用教程

    介绍 Fontisto 是一个开源的字体图标库，其中包含了超过 600 个精美的图标，可以通过 npm 包直接在前端工程中引用。 在本篇文章中，我们将介绍如何在前端项目中使用 Fontisto，包括如...

    4 年前
  • npm 包 frac 使用教程

    什么是 npm 包 frac？ npm 包 frac 是一个能够将分数转化为小数的 JavaScript 库。这个库可以帮助我们在前端开发中实现对分数的处理和计算，解决某些情况下小数精度丢失的问题。

    4 年前
  • npm 包 @handsontable/formulajs 使用教程

    前言 在前端开发中，我们常常需要处理大量的数据。而数据处理中的公式计算是一个很重要的环节，因为它能减轻我们的工作量，提高数据的处理速度。在这方面，@handsontable/formulajs 是一个...

    4 年前
  • npm 包 fancy-terminal 使用教程

    前言 在前端开发中，我们经常需要使用命令行工具进行一些操作。然而，命令行工具的默认样式和功能非常有限，难以满足我们的需求。这时候，一些优秀的 npm 包就可以派上用场了。

    4 年前

相关推荐

    暂无文章