phpdoc

4熱度

2回答

我有一個PHP類的方法。在基類中（它更像一個原型，但我沒有使用原型，因爲我們必須向後兼容），我記錄了該方法的參數和描述。現在我擴展這個類。在這種新方法（實施）中，我是否應該重新記錄參數和說明，是否應該留空，還是隻留下適用於特定實施的相關說明？我的目標是讓可讀的API文檔由PhpDoc生成，並遵循約定。

0熱度

1回答

如何在phpDoc/javaDoc中記錄訪問器/增變器方法？

鑑於其表現爲無論是根據傳遞給它的參數賦值函數或訪問，這樣的功能： // in PHP, you can pass any number of arguments to a function... function cache($cacheName) { $arguments = func_get_args(); if (count($arguments) >= 2) { /

0熱度

3回答

有沒有任何工具可以自動檢查javaDoc（phpDoc等）的質量？

你知道任何可以運行代碼並找到javaDoc塊中缺陷的工具嗎？（也很好解析其他語言，如PHP，C＃等）。

1熱度

2回答

netbeans中的評論代碼？

前一陣子我可以發表評論在PHP的任何代碼，像這樣的NetBeans： /* * * */ 我剛纔輸入/ *輸入和NetBeans給我，上面的紋路。然後當我輸入@時，它給了我所有可用標籤（作者，參數等）的完整列表。我重新安裝了我的mac，從那以後它沒有工作。有人知道爲什麼以及如何激活它？我只安裝了PHP的netbeans。

3熱度

1回答

文檔在PHP中的包？

所以在一個文件夾貝寶我有多個類使用他們的API。我想做一個關於如何按順序使用所有類的文檔。所以這裏是我的問題：我該如何爲他們創建一個軟件包？導致每個班上面我使用phpdoc標籤@package貝寶。是隻在一個文件夾的PHP包？我在哪裏把包的文件？有這方面的最佳做法？名爲...的文件夾中的文件？如何把類或包的具體例子，例如。第1步，bla bla，第2步bla bla？謝謝！

0熱度

1回答

OSX上的PHP Doc軟件？

我使用我的OSX開發。 PHP和現在我需要嘗試PHPDoc，但如何？ sombardy知道一個軟件嗎？或者我可以做到嗎？我試圖看看這裏http://manual.phpdoc.org/HTMLSmartyConverter/HandS/ric_INSTALL.html但我希望我能找到一個GUI軟件了。 :) 坦克的所有幫助。

1熱度

1回答

PHPDoc函數更改日誌（@change？）

用PHPDoc記錄函數中更改的最佳方式是什麼？像 @change 2010.20.16 user added feature x @change 2010.20.26 user added feature y 會很好。但是，假設沒有@change選項...如果我反正添加它，PHPDoc將如何處理它？還是有更好/更正確的方法來記錄功能變化？

6熱度

3回答

用PhpDoc記錄PHP多重繼承

我有這樣的多重繼承：Can I extend a class using more than 1 class in PHP?（讓我們不要討論這個方法本身），並希望我的IDE瞭解繼承的類方法和屬性。有沒有辦法用PhpDoc做到這一點？

17熱度

2回答

評論關聯數組在PHP Documentor

我在我的PHP應用程序中使用幾個關聯數組，我使用PHP documentor來評論我的來源。我從來沒有真的爲數組中的數組指定註釋，但現在我需要這樣做，不知道如何。 $array = array('id' => 'test', 'class' => 'tester', 'options' => array('option1' => 1, 'option2' => 2)) 如何評論這個數組中的@v

4熱度

1回答

如何使用PHP解析phpDoc樣式註釋塊？

請考慮下面的代碼與我試圖解析只有第一個PHPDoc的風格註釋在一個文件中（不使用任何其他庫）（放在$數據變量用於測試文件的內容）： $data = " /** * @file A lot of info about this file * Could even continue on the next line * @author [email protected] * @versi