用phpDocumentor解析Javascript文件

最近我一直在玩phpDocumentor，發現它非常適合我的需求。我主要使用PHP/HTML/JS/CSS代碼庫，並希望phpDocumentor解析我的Javascript（也許是CSS），以便將它們放在一起。用phpDocumentor解析Javascript文件

我已經設法讓phpdoc解析整個代碼庫中包含的JavaScript文件 - 但它拒絕了頁面級的docblock - 這導致它拒絕各種標籤（見下文）。我發現，通過在JavaScript文件的頂部添加一個PHP開放標記（帶有JavaScript註釋），我可以將其解析爲PHP文件。

// <?php 
/** 
* phpdoc goes here 
* @package 
* @todo 
* - Todo 1 
* - Todo 2 
*/ 
function javascript(goes, here) { 
}

我能想到的應該發生的網絡服務器是安裝到服務器.js文件通過PHP的問題。任何人都可以想到其他問題嗎？有沒有更好的方法來實現這一點？

感謝

來源

2009-11-22 ncatnow

至於潛在的問題，一個是想到的是，因爲你「欺騙」phpDocumentor分析文檔塊和JS代碼，你隱式指望PHP tokenizer（這是phpDocumentor如何在內部解析PHP代碼）成功讀取您的JS代碼並將其視爲PHP代碼。當這個成功時，我認爲你會有很好的結果......你簡單的函數示例應該可能成功。但是，如果您的JS代碼將而不是解析爲PHP代碼成功，那麼我敢打賭，phpDocumentor將不會將其視爲可文檔化的代碼元素，因此它不會出現在您的文檔中。

來源

2009-11-22 13:23:58 ashnazg

我覺得這是一個有點天真地認爲有對JavaScript沒有類似的工具。

有一個名爲JSDoc的工具，它基本上與phpdoc相同，但是用於JavaScript。

更新週五，2015年5月1日 -

它看起來像新的項目鏈接： -

https://github.com/jsdoc3/jsdoc

來源

2009-11-22 10:51:34

我也不知道JSDoc。不過，我可以看到@ncatnow的觀點：在一個地方和佈局上生成文檔，而不是必須使用兩種解決方案和兩種不同語言的兩種設置，這將是lovley。至少對於單一功能的Javascript，這應該是可能的，不是嗎？ - – 2009-11-22 10:59:56

也許試試Doxygen？它類似於PHPDoc，也支持PHP和afaik JavaScript。儘管我自己並沒有使用它。 – 2009-11-22 11:31:11

@Jani Hartikainen：我認爲我認爲我還沒有研究過這個問題有點天真。我看了一下JSDoc，但是當我想要的只是將幾個JS文件包含在當前文檔集中時，它有點超過了頂層，並帶有一些簡單的'phpdoc'，它允許我設置一些todo項目，將其打包，等等。 Pekka是對的錢。正如我所說 - 從文檔生成的角度來看，我已經有了這個工作。我很想知道其他人是否已經做到了這一點，並且使它的工作方式超過了我。 – ncatnow 2009-11-22 12:53:13

我在找同樣的東西。我找到了JSDoc和PhpDocumentor，但考慮到1（ONE）應用程序作爲「整體」包含PHP和JavaScript作爲應用程序的基礎，我更願意使用1種方法來記錄項目。它真的很糟糕，有2個文檔集，1個用於php，1個用於JavaScript。那個ole @see或inline @link在下列情況下不起作用：@通過其他文檔程序查看這個其他函數/類在這個其他語言中......讓我的漂移？

來源

2011-11-08 01:38:47

用phpDocumentor解析Javascript文件

回答

相關問題