介绍
markdox-2 是一款命令行工具，可以从 JavaScript 代码中提取注释，并将其转换为 Markdown 格式的文档。它使用了 Mustache 模板引擎，因此可以根据自己的需求定制文档的样式。
安装
全局安装：
--- ------- -- ---------
局部安装：
--- ------- ---------
使用
提取注释
提取注释并生成 Markdown 格式文档：
--------- ------- ------ -------- ------
其中，--input 指定需要提取注释的 JavaScript 文件路径，--output 则指定输出路径。
如果需要生成的文档需要包含模板文件，可以使用 --template 选项：
--------- ------- ------ -------- ------ ---------- ------
定制文档
markdox-2 使用 Mustache 模板引擎生成文档，因此可以根据需要定制样式。
默认情况下，文档中只包含注释和代码，没有标题或者其他元素。如果要添加标题，可以在模板文件中添加：
- -- -------- --
其中，basename 是文件名。
如果要添加更多内容，可以使用 Mustache 的语法，在模板文件中添加：
------------
- --------
---------
-------
---------
-- --- --
-------------
----------{% endraw %}
{{/context}}
--------------------- -------------------------------- - ----------- ------------------------------------- ----------------------- -------------------- -- -- ------------- ------------- --- - -------- - - ------ -------- - ----- - ------ -------- - ----- - -------- -------- ------ -- -------- ------ -- - ------ - - -- - --- - -------- - - ------ -------- - ----- - ------ -------- - ----- - -------- -------- ------ -- -------- ----------- -- - ------ - - -- -
使用以下模板文件：
- ------------
------------
-- --------
---------
-------
---------
-------------
---------
-----------
---------{{/context}}
--------
index.js
add
获取两个数字之和
参数
a(number): 第一个数字b(number): 第二个数字
返回值
(number): 两个数字之和
-------- ------ -- - ------ - - -- -
subtract
获取两个数字之差
参数
a(number): 第一个数字b(number): 第二个数字
返回值
(number): 两个数字之差
-------- ----------- -- - ------ - - -- -
-- -- ----------- ------------------ ---------- --------- -------- ---------------------------------------------- ---------------------- ------------------------------------------------------------------------------ ---------- -----------------------------------------------------------------------------------------------------------------------------