用于BOTH Javascript和PHP的文档生成器工具

时间:2010-06-02 12:13:19

标签: php javascript documentation documentation-generation code-documentation

您是否知道可以轻松创建JavaScript和PHP代码文档的工具?

在代码中采用类似于下面所示的注释的东西:

/**********************************************************
This function does something special...

param1: ...
param2:

RETURNED VALUES:
...
**********************************************************/
function something(...)
{
   ...

并将这些转换为HTML文件(可能左侧有框架集菜单)。 不需要上面显示的相同语法,这只是一个例子来解释我在说什么。

只想使用一个工具,一旦我学会了编写文档的语法,我就可以使用 PHP和JavaScript的相同文档语法。

如果该工具是二进制(.exe)或Java代码,那将是很好的,无需安装PERL或PYTHON。

2 个答案:

答案 0 :(得分:2)

Doxygen可以处理开箱即用的PHP,而helper scripts可以使用Javascript(但这确实需要Perl)。

答案 1 :(得分:-1)

没有冒犯,但Web开发(尤其是PHP)的世界仍然是一个主要基于Unix的世界。如果您自动折扣基于Perl,Python或其他脚本语言(如PHP!)的任何内容,您的选项会大大减少,特别是如果您不想为此付费。

您应该能够安装Perl二进制文件,然后只运行脚本......