简介
mochadoc-runner是一个在Node.js环境中使用的基于mocha的文档测试工具。它可以将mocha测试用例中的代码与测试代码之间的注释解析为markdown文档，并输出到指定的目录，从而为项目提供文档生成的功能。
安装
使用npm进行安装：
--- ------- --------------- ----------
使用
1. 初始化测试用例
首先需要在项目中创建一个测试用例文件夹，例如test，并在其中编写mocha测试用例：
-- ---- --
----- ------ - ------------------
----------------- -------- -- -
---------------------- -------- -- -
---------- ------ -- ---- --- ----- -- --- --------- -------- -- -
---------------------- -- -------------- ----
---
---
---2. 编写注释文档
在测试用例中，通过注释的方式编写文档内容。注释格式为：
---- - ------ -- - ------------ -- - ------ ------ ---- - -- - ------- ------ - -- --
其中，title为标题，description为描述，param为函数参数描述，return为函数返回值描述。例如：
---- - ------ --- - ------------ --- --- ------- - ------ -------- - - --- ----- ------ - ------ -------- - - --- ------ ------ - ------- -------- --- --- -- --- --- ------- -- -------- ------ -- - ------ - - -- -
3. 运行测试
运行以下命令，将会在指定目录（默认为docs）下生成markdown文档：
-----------------------------------
4. 示例代码
下面是一个完整的示例：
-- --------
----
- ------ ---
- ------------ --- --- -------
- ------ -------- - - --- ----- ------
- ------ -------- - - --- ------ ------
- ------- -------- --- --- -- --- --- -------
--
-------- ------ -- -
------ - - --
-
----
- ------ --------
- ------------ -------- --- -------
- ------ -------- - - --- ----- ------
- ------ -------- - - --- ------ ------
- ------- -------- --- ---------- -- --- --- -------
--
-------- ----------- -- -
------ - - --
-
----
- ------ --------
- ------------ -------- --- -------
- ------ -------- - - --- ----- ------
- ------ -------- - - --- ------ ------
- ------- -------- --- ------- -- --- --- -------
--
-------- ----------- -- -
------ - - --
-
-- ------------
----- ------ - ------------------
----- - ---- --------- -------- - - --------------------
---------------- -------- -- -
------------------ -------- -- -
---------- --- --- --------- -------- -- -
------------------------- --- ---
---
---
----------------------- -------- -- -
---------- -------- --- --------- -------- -- -
------------------------------ --- ---
---
---
----------------------- -------- -- -
---------- -------- --- --------- -------- -- -
------------------------------ --- ---
---
---
---在命令行中运行./node_modules/.bin/mochadoc-runner命令，将会在默认目录docs下生成如下markdown文档：
- ---- -- --- --- --- ------- --------- ------ -------- - ----- - ---- - ----------- - ------------------------------------------------------------------------------------------ - - - ------ - --- ----- ------ - - - - ------ - --- ------ ------ - ------------ ------ - --- --- -- --- --- ------- -- -------- -------- --- ------- --------- ------ -------- - ----- - ---- - ----------- - ------------------------------------------------------------------------------------------- - - - ------ - --- ----- ------ - - - - ------ - --- ------ ------ - ------------ ------ - --- ---------- -- --- --- ------- -- -------- -------- --- ------- --------- ------ -------- - ----- - ---- - ----------- - ------------------------------------------------------------------------------------------ - - - ------ - --- ----- ------ - - - - ------ - --- ------ ------ - ------------ ------ - --- ------- -- --- --- -------
结语
使用mochadoc-runner可以很方便地将测试用例中的注释文档解析成markdown文档，从而为项目提供文档生成的功能，不仅提高了代码的可读性，也方便了项目的协作开发。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/6005671681e8991b448e36a0