2012-01-02 59 views
6

我從來沒有在意關於如何記錄我的代碼,但最近我開始研究一個開源項目,並且需求出現了。很明顯,「武器的選擇」是PHPDoc,但...PHPDoc的狀態如何?

我無法真正找到PHPDoc標準的單一規範。有一個維基百科條目列出了一些屬性,並有phpDocumentor項目,它據說有一個更廣泛的字典,但令我感到困惑的是PHPDoc的權威性指南在哪裏?是否有單一的標準,或者取決於所有那些衆多的PHPDocument或者PHPDoc「標準」(如果有的話)

如果我們假設phpDocumentor是創建和維護PHPDoc標準的地方,事情看起來相當嚴峻,因爲the project's website現在已經死了大約4年了,而更令我困惑的是,一個月前版本1.4.4突然出現在phpDocumentor的梨網站上。

我知道這裏有很多更聰明,更有知識的人,所以我想知道。什麼是PHPDoc的交易。是否有單一的權威機構來創建標準?它有多可靠?是否有任何未來或我們正在處理與殭屍和所有的希望都失去了......

感謝, 伊沃

+0

不是堆棧溢出的問題 – 2012-01-02 05:32:30

+8

@Dagon - 我不同意。它屬於['編程界專有的實用,可回答的問題](http://stackoverflow.com/faq)。 – 2012-01-02 05:40:38

+3

僅供參考,一段時間沒有更新的網站不會使網站(或該項目,就此而言)「死亡」。它可能只是一個新版本已經超過3年了,因爲這個軟件能夠做到這一點,並且做得很好。 – cHao 2012-01-02 05:41:51

回答

1

這個問題已經有點老了,但爲了提供信息,我應該補充說DocBlox已經與PhpDocumentor合併了。

宣佈phpDocumentor 2 - 合併舊的(phpDocumentor) 和新的(DocBlox)。

有了phpDocumentor的(2.0.0a1)的第一個alpha版本,新 「響應」默認模板體育一個新的頁面佈局,與原DocBlox模板 提供的 有用佈局的改進(這仍然可用)沿在舊的phpDocumentor模板 (這將退休與舊的phpDocumentor)。探索這個新模板 在http://demo.phpdoc.org/Responsive/index.html

=>http://www.docblox-project.org/2012/03/docblox-is-unmasked-it-is-really-phpdocumentor-2/

PHPDoc的是回動作。 =)

2

根據維基百科it's dead

PhpDoc標記的標準規格曾經是PhpDocumentor文檔中列出的標準。但就像我說的,它已經死了。由於DocBlox似乎填補了PhpDocumentor留下的空白,我建議使用DocBlox documentation作爲您如何進行PhpDoc評論的基礎。

我希望Netbeans 7.1會引入DocBlox支持,因爲它好多了。這是PHP 5.3的意識,並積極維護。

+1

感謝您的評論。我知道那裏有大量的文檔生成器,但它們似乎都在PHPDoc基礎上擴展,所以我暗中希望會有一個標準,但我想也許不是。現在我個人對發生器的選擇是 - http://apigen.org – 2012-01-02 20:21:59

+1

如果它們都似乎擴展phpDoc ...那麼...應該告訴你一些東西。也就是說,*有*是doc評論的一個主要標準。你使用的系統可能會改變,但評論幾乎是一樣的。 – cHao 2012-01-04 03:23:23

+1

我通過電子郵件發送了一些phpdocumentor的開發者,他告訴我這個項目並不是'死亡',但不會被增強以獲得PHP 5.3的特性(維基百科文章也相應更新,不再將項目列爲已停用) 。我同意@IvoSabev,apigen是我個人的最愛。 – William 2012-01-30 21:25:10