必威体育下载基督教Heilmann

您当前正在浏览“助手”类别的存档。必威体育简介

“助手”类别的存档

使用Tutorialbuilder从源注释生成教程

周二,5月13日,2008

我花了太多的时间让脚本的解释教程与代码的更改保持同步。这就是我写a的原因PHP解决方案为我做这项工作。多年来,我发现解释剧本的最好方法是:

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

如果你去看看Tutorialbuilder你会看到我用a实现了大部分的自动化PHP脚本。它为您做了以下工作:

  • 它从脚本源代码中的注释生成教程部分。
  • 它将源代码转换为可显示的代码(编码它,添加行号,允许行被高亮显示)
  • 它使用正确的文件名创建脚本的可下载版本
  • 它创建脚本的可执行版本,而不需要使用脚本元素链接注释。
  • 它可以缩小脚本(删除所有空格以减少文件大小)

换句话说,结果这个源脚本像这样的教程使用一个模板和一些CSS(大部分取自YUI)。

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

Tutorialbuilder许可和BSD,所以为了你自己疯狂的使用它。