简介
J2-Grunt-jsdoc 是一个生成 JavaScript API 文档的 Grunt 插件，使用 JSDoc 工具生成文档。JSDoc 可以在代码中提取注释，根据注释生成文档。J2-Grunt-jsdoc 是在 JSDoc 基础上封装的 Grunt 插件，使用起来更加方便。
安装
npm install j2-grunt-jsdoc --save-dev
使用
- 在 Gruntfile.js 中配置插件：
-- -------------------- ---- -------
-------------- - --------------- -
------------------
----- - -
---- - -
---- ----------------
-------- -
------------ -----
-
-
-
---
-------------------------------------
------------------------- -----------
-- 在需要生成文档的 JavaScript 文件中添加注释：
-- -------------------- ---- ------- --- - ------- - ------ -------- - -- - ------ -------- - -- - ------- -------- ---- -- -------- ------ -- - ------ - - -- - --- - ------ - - ------------ - ------ -------- ---- -- - ------ -------- --- -- -- -------- ------------ ---- - --------- - ----- -------- - ---- - --- - ------ ------------- - ------- -- -------------------------- - ---------- - ------------------ - - --------- - ---- - - -------- - - ----- -
- 运行
grunt doc生成文档。
配置项
src: 需要生成文档的 JavaScript 文件路径。可以使用 Grunt 的**通配符匹配多个文件或文件夹。options.destination: 生成的文档输出目录。
示例代码
见上文中的配置项中的示例代码。
意义
生成 API 文档是每个项目必不可少的一环。API 文档不仅能够帮助项目成员了解项目的接口，而且对其他开发者使用项目提供了必要的帮助。J2-Grunt-jsdoc 的出现简化了 API 文档的生成过程，提高了效率，也为文档协作提供了保障。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600562d681e8991b448e0304