2010-02-26 84 views
0

我記錄在代碼庫中的所有文件將始終使用相同的版本「字符串」有沒有一種方法我可以在一個地方爲PhpDocumentor使用相同的版本的所有文件,無論指定或不是(應該自動繼承)在PhpDocumentor中,有沒有辦法指定默認的版本號?

...還有什麼其他標籤可以在您的頭頂有用嗎?

編輯:

任何可以解決親子關係的東西?就像.ini或配置文件,用於閱讀版本,作者,版權?

回答

1

我不知道PHPDocumentor允許這樣的事情。

此外,在所有文件上使用相同的版本對我來說似乎是錯誤的用法。版本註釋給出特定文件的版本。如果您要修復A類錯誤,爲什麼B類版本會發生變化?

至於在多個文檔中插入相同的註釋,我建議查看您的IDE模板功能。通常,您可以像這樣配置片段,並使用鍵盤快捷方式或創建新文件時插入片段。

另一種選擇是在通過部署腳本(如Phing或Ant)或通過代碼存儲庫中的預提交掛鉤創建文檔時設置和替換註釋值。


編輯經歷的phpdocumentor manual再次,我發現這一點:

的{} @inheritdoc內嵌標籤中的類,方法和子類的類變量的文檔塊中使用。 phpDocumentor將自動繼承父類的@author標記,@version標記和@copyright標記。另外,如果沒有文檔評論,它會繼承父文檔。

請注意,如果{@inheritdoc} inline標記不存在,並且子類沒有記錄,則子類仍然會嘗試按照原樣從父類繼承文檔。 {@inheritdoc}允許靈活地將父類的文檔放在子類的文檔中。

這不完全是你在找什麼,但它是一個類似的方向。

+0

這是一種混亂。在一部分中,我同意應該有一種方法來跟蹤文件的版本,另一方面,「已發佈」文檔應該用於版本X.Y.Z.我會再次看IDE設置謝謝:) – Urda 2010-02-27 20:52:02

+0

@Urda您可以通過在您的源代碼存儲庫中標記或分支您的應用程序來處理此問題。我也再次更新了答案。 – Gordon 2010-02-28 09:51:41

+0

關於inheritdoc的有趣故事。我似乎永遠無法按預期工作。星期五試了兩個小時左右。 – Urda 2010-02-28 19:06:14

相關問題