2010-08-25 53 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