Warning: file_get_contents(/data/phpspider/zhask/data//catemap/9/javascript/460.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
Javascript JSDoc教程包括源文件_Javascript_Jsdoc3 - Fatal编程技术网
Fatal编程技术网
  • javascript/
  • Javascript JSDoc教程包括源文件

Javascript JSDoc教程包括源文件

javascript

Javascript JSDoc教程包括源文件,javascript,jsdoc3,Javascript,Jsdoc3,我有一个使用JSDoc3记录的JavaScript项目，我正在添加教程（用HTML编写）。我的项目中有一个示例代码，由用户可以运行的一系列脚本组成，我正在编写教程来解释每个示例脚本的作用。我想在每个教程的顶部有一个解释性文本的简介，然后包括一个示例脚本。我可以将示例代码复制并粘贴到教程文件中，并将其正确格式化，但理想情况下，我希望包含该文件，以便不必在两个单独的位置维护示例代码。如何使用JSDoc3实现这一点？我没有一个纯JSDoc的解决方案，但我知道（测试框架）可以从测试文件生成足够好的文档，

我有一个使用JSDoc3记录的JavaScript项目，我正在添加教程（用HTML编写）。我的项目中有一个示例代码，由用户可以运行的一系列脚本组成，我正在编写教程来解释每个示例脚本的作用。我想在每个教程的顶部有一个解释性文本的简介，然后包括一个示例脚本。我可以将示例代码复制并粘贴到教程文件中，并将其正确格式化，但理想情况下，我希望包含该文件，以便不必在两个单独的位置维护示例代码。如何使用JSDoc3实现这一点？

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

解决方法1 解决方案可能如下所示：

  • 将您的样本转换为
    摩卡
  • 为新的测试文件运行
    mocha--reporter=doc
  • 将
    mocha
    的输出转发给预处理器以生成样式化文档
    • 使用此解决方案，您将获得一项奖励：将对示例进行测试

    变通办法1.a 还有其他的
    mocha
    记者：html，markdown，json。我们可以在第一个解决方案的以下变化中使用降价报告程序：

  • 样本=>测试
  • 运行
    mocha-r降价
  • 将
    mocha
    的输出存储到JSDoc教程的根目录中
  • 运行
    jsdoc
    （生成教程）
    • 主要区别在于：利用JSDoc的