必威体育下载克里斯蒂安·海尔曼

γ使用TutorialBuilder从源注释生成教程

星期二,5月13日,2008年上午11:47

我花了太多时间来保持脚本的解释教程与代码中的更改同步。所以我给自己写了一封PHP为我做这项工作的解决方案。多年来,我发现解释剧本最好的方法是:

  • 举个例子
  • 显示完整的源代码
  • 逐位显示源代码,然后解释每个部分的功能

如果你去查一下教程建造者你会看到我用PHP脚本。它为您执行以下操作:

  • 它根据脚本源代码中的注释生成教程部分。
  • 它将源代码转换为可显示代码(对其进行编码,添加行号,允许突出显示行)
  • 它使用正确的文件名创建脚本的可下载版本
  • 它创建一个脚本的可执行版本,不带注释,可通过脚本元素链接到该版本。
  • 它可以缩小脚本(删除所有空白以减小文件大小)

换言之,它转弯此源脚本进入之内像这样的教程使用模板和一些CSS(大部分取自悠悠

它是替代JSDoc但是相反,它更容易使用和解释代码的功能,而不是JS代码本身的语法。

教程建造者授权给BSD,所以你自己动手吧。

标签:

在Twitter上分享