如果你是一个前端工程师，你一定知道在开发过程中文档的重要性。文档可以帮助开发者更好地理解代码，降低维护成本。generator-canonical-documentation 是一个优秀的 npm 包，它可以帮助你快速生成代码文档，减轻你的文档编写负担。在本篇文章中，我们将详细介绍使用 generator-canonical-documentation 的方法。
安装
使用 npm 安装 generator-canonical-documentation。
npm install -g generator-canonical-documentation
使用
- 进入你的项目目录。
cd /path/to/your/project
- 生成文档
yo canonical-documentation
执行这个命令后，它会要求你输入一些信息，这些信息包括代码描述，版本号，作者信息，许可证等等。
- 在你的项目目录下会生成一个
docs目录，里面包含自动生成的文档。
配置
在 generator-canonical-documentation 执行过程中，你可以通过命令行参数或者交互式命令来自定义一些配置：
- 类型
yo canonical-documentation --type function
默认情况下，generator-canonical-documentation 会生成所有类型的文档，包括：函数，变量，类等等。使用 --type 参数可以指定生成的文档类型，这样可以节省时间以及让你专注于你需要的文档。
- 目录
yo canonical-documentation --dir ./documents
默认情况下，generator-canonical-documentation 会在你的项目目录下生成 docs 目录。使用 --dir 参数可以指定一个目录来保存生成的文档。
- 配置文件
yo canonical-documentation --config ./config.json
默认情况下，generator-canonical-documentation 会使用交互式命令来获取项目信息。使用 --config 参数可以指定一个 JSON 文件来提供这些信息。
示例代码
例如，我们有一个 sum.js 文件：
-- -------------------- ---- ------- --- - --------- - - ------ -------- - ----- - ------ -------- - ----- - - -------- -------- ------- - - -------- - - ----- --- - ----------------- - - ------------------ ---- -- - -- -------- ------ -- - ------ - - -- - -------------- - ----
执行 yo canonical-documentation 后，它会自动解析上面的注释，并生成一个 sum.md 文件：
# sum 计算两个数字的总和 ## 语法 ```javascript sum(a, b)
参数
a(number, 必填) - 第一个数字b(number, 必填) - 第二个数字
返回值
number- 两个数字的总和
示例
const sum = require('./sum');
console.log(sum(1, 2)); // 3作者
- 作者名字: John Doe
- 作者电子邮件: john@doe.com
- 作者网站: http://johndoe.com
许可证
MIT
-- -------------------- ---- ------- --------------------------------------------------------------------------- -- -- ----------------------------------- -------- --- --------------------------------------------------------- ------------------------------------ - ------------------------------------------------------------------------------ -------- ------------------------------------------------------------------------------------------------------------------------