JSDoc教程包含源文件

Question

我有一个使用JSDoc3记录的JavaScript项目，我正在努力添加教程（用HTML编写）。我的项目中有一些示例代码，包含用户可以运行的一系列脚本，我本质上是编写教程来解释每个示例脚本的作用。我希望在每个教程的顶部都有一些解释性文字，然后包含一个示例脚本。我可以将示例代码复制并粘贴到教程文件中并正确格式化，但理想情况下，我希望包含文件，以便我不必维护两个不同位置的示例代码。如何使用JSDoc3完成此操作？

Answer 1

我没有纯粹的仅JSDoc 解决方案，但我知道，Mocha（测试框架）可以使用{{从测试文件生成足够好的文档3}}

解决方法1

解决方法可能如下所示：

1. 将您的样本转换为mocha
的测试
2. 运行mocha --reporter=doc以获取新测试文件
3. 将mocha的输出转发到预处理器以生成样式文档

使用此解决方案，您将获得一个奖励：将测试示例。

解决方法1.a

还有其他mocha记者： html ，降价， json 。我们可以在第一个解决方案的以下变体中使用降价报告器：

1. samples =＆gt;测试
2. 运行mocha -r markdown
3. 将mocha的输出存储到JSDoc教程的根目录
4. 运行jsdoc（生成教程）

主要区别：利用JSDoc的doc-reporter