我正在为正在进行扩展的内部网络应用生成API文档。它是一个DHTML项目,包含一些OO和大多数程序性PHP,以及纯粹的程序性Javascript。目前,对于相应的文档生成器(phpdocumentor和jsdoc)来说,它几乎都记录在案,但两者从未“连接”过。我可以通过手工链接语句添加到文档块,但管理所有这些链接(如“../jsdoc/filename.html#function”)真的很痛苦。
有关处理PHP和JavaScript的文档生成器的任何建议,并允许在语言之间使用@see functionName吗?
如果最坏的情况发生,我可以将一个脚本用一些神奇的语法(即js:和php :)重写LINK URL,但我真的宁愿有一些东西允许对所有内容进行统一的树视图。
谢谢, 杰森
答案 0 :(得分: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/