在前端开发中，我们经常需要编写文档来记录代码的用法和API。documentation-custom-markdown 是一个npm包，它提供了一种方便快捷的方式来生成美观且易于阅读的markdown格式文档。
安装
你可以使用npm来安装这个包：
npm install -g documentation-custom-markdown
使用方法
在项目根目录下创建一个名为docs的文件夹，并在其中创建一个名为index.js的文件。
在index.js中编写代码并添加注释。注释应该遵循javadoc风格，并且必须以/*开始和/结束，例如：
-- -------------------- ---- ------- --- - ---- -------- ---- --- -------- - - ------ -------- - - --- ----- ------ -- --- - ------ -------- - - --- ------ ------ -- --- - ------- -------- --- --- -- - --- - -- -------- ------ -- - ------ - - -- -
打开终端，进入项目根目录，运行以下命令来生成文档：
documentation-custom-markdown src/*.js -f markdown -o docs/api.md
这将会在docs文件夹中生成一个api.md文件，其中包含了所有在src文件夹下的JS文件中所定义的函数和参数的文档。
示例代码
以下是一个简单的示例，演示如何使用documentation-custom-markdown来生成文档：
-- -------------------- ---- -------
---
- ---- -- - ------ -------- ---- ------- --- ------ -- - -------
-
- ------ -------- - - --- ------ -- ------
- ------- -------- --- ------ -- -
--
-------- --------- -
------ - - --
-
---
- ---- -- - ------ ----- ---- ---------- - -------
--
----- ------ -
---
- ------- - --- ------ ---- --- ----- ---- --- ----
-
- ------ -------- ---- - --- ---- -- --- ------
- ------ -------- --- - --- --- -- --- ------
--
----------------- ---- -
--------- - -----
-------- - ----
-
---
- ------- - ------ -------------- -- ---- -------
-
- ------- -------- - ------ -------------- -- ---- ------
--
---------- -
------ ------------- ------------ ----- ------
-
-运行以下命令以生成文档：
documentation-custom-markdown index.js -f markdown -o docs/api.md
这将会在docs文件夹中创建一个api.md文件，其中包含了上述示例代码中所定义的函数和类的文档。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/45626