2010-08-25 59 views
2

我正在为正在进行一些扩展的内部Web应用程序生成API文档。这是一个DHTML项目,结合了一些OO和大部分程序化PHP,以及纯程序化的Javascript。目前,几乎所有文档都记录在适当的文档生成器(phpdocumentor和jsdoc)中,但两者从未“连接”。我可以通过并添加手动链接语句的文档块,但管理所有这些链接(如“../jsdoc/filename.html#function)是一个真正的痛苦。PHP和Javascript文档生成器

任何建议文档生成器处理PHP和JavaScript,并允许诸如语言之间的@see functionName之类的东西?

如果最坏的情况最糟糕,我可以一起修改一个脚本以从一些魔术语法(即js:和php :)重写LINK URL, ð真的,而有一些,让一切的统一的树视图。

感谢, 杰森

+0

的一个选项,我发现是Doxygen的通过一段JavaScript脚本工具......我要去给它一个今天开枪。 – 2010-08-25 13:32:54

回答

1

查看了很多选项后,我编写了一个PHP脚本,用于解析JS文件,取出文档块和函数定义,然后将其写入phpdoc可以处理的文件。它只需要将一行添加到phpDocumentor.ini中,以便解析.js文件。

博客文章谈论它是: http://blog.jasonantman.com/2010/08/documentation-generation-for-web-apps-php-and-javascript/ 和脚本是: http://svn.jasonantman.com/misc-scripts/

+0

获得此脚本使用phpdocumentor 2的任何机会?或者你知道它是否可以像phpdoc 2一样工作吗?我可能会继续尝试,但只是想看看你是否已经完成了这项工作。 :) – 2012-12-13 15:52:12