什么是 dochammer？
dochammer 是一个基于 Node.js 的 npm 包，旨在帮助开发者快速生成 API 文档。它支持将注释转化为 Markdown 格式的文档，同时还支持 Swagger 的 YAML 格式文档生成。使用 dochammer，开发者可以省去手写文档的繁琐过程，提高开发效率。
安装 dochammer
在命令行中输入以下命令，即可安装 dochammer：
npm install -g dochammer
使用 dochammer 生成 API 文档
- 在项目中添加注释
在需要生成文档的 JavaScript 代码中，添加 JSDoc 注释。
-- -------------------- ---- ------- --- - -- - - ------ -------- - ----- - ------ -------- - ----- - -------- -------- ------ -- -------- ------ -- - ------ - - -- -
- 生成 API 文档
在命令行中输入以下命令，即可生成 Markdown 格式的 API 文档。
dochammer -i input.js -o output.md
其中，-i 表示输入文件，-o 表示输出文件。
- 预览 API 文档
生成的 API 文档可以用编辑器（如 VS Code）打开，进行预览和编辑。
使用 dochammer 生成 Swagger 文档
- 在项目中添加注释
在需要生成文档的 JavaScript 代码中，添加 Swagger JSDoc 注释。
-- -------------------- ---- ------- --- - -------- - --------- - ----- - -------- --- --- ------- - ------------ ------- --- ------ -- ------ --- ------- - ------------ - -------- - ----------------- - ------- - ----- ------ - ----------- - -- - ----- ------ - ------------ --- ----- ------ - -- - ----- ------ - ------------ --- ------ ------ - --------- - - - - - - - ---------- - ---- - ------------ --- --- -- --- ------- - -------- - ----------------- - ------- - ----- ------ - ----------- - ------- - ----- ------ - ------------ --- --- -- --- ------- - ---- - ------------ --- ------- - ---- - ------------ -------- ------ ----- -- -------- -------- ---- - ----- - -- - - - --------- ----- ------ - - - -- ---------- ------ --- -
- 生成 Swagger 文档
在命令行中输入以下命令，即可生成 Swagger 的 YAML 格式文档。
dochammer -s input.js -o output.yaml --swagger
其中，-s 表示输入文件，-o 表示输出文件，--swagger 表示生成 Swagger 文档。
- 预览 Swagger 文档
生成的 Swagger 文档可以用 Swagger UI 进行预览和编辑。
-- -------------------- ---- -------
--------- -----
------
------
-------------- ----------
----- ------------------------------------------------------- ---------------- --
-------
------
---- ----------------------
------- ------------------------------------------------------------ -------------------------
--------
------------- - ---------- -
----- -- - -----------------
---- --------------
------- --------------
--
-
---------
-------
-------结语
使用 dochammer，可以帮助开发者更高效地生成 API 文档和 Swagger 文档，使项目开发更加便捷。同时，在项目开发中，添加注释也是一项良好的编程习惯，能够更好地提高代码的可维护性和可读性。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600672513660cf7123b362d8