2017-08-04 184 views
0

我正在寫很多單元測試,恐怕有一天我會回來閱讀測試代碼,不能理解測試的內容。如何記錄PHPUnit測試

的問題是:我如何使用文件PHPDoc的PHPUnit的測試?

+2

爲什麼這個問題被upvoted兩次? – Bhavin

+0

爲什麼這個問題不應該是@Bhavin? – e200

+0

就像你要記錄其他東西一樣? – iainn

回答

1

使用@covers註釋(它特定於PHPUnit,而不是phpDocumentor使用的文檔標記)來突出顯示測試用例應該執行的操作。通過將它放在docblock中,您可以告訴代碼閱讀器測試所針對的代碼。如果您的phpDocumentor也爲您的測試用例生成文檔,那麼它應該將註釋視爲「自定義標籤」,並將其顯示爲通用信息。但請注意,@covers的目的是限制PHPUnit完成的代碼覆蓋率測量。它作爲doc信息使用是偶然的,但很有用。

如果您想要在測試用例和測試代碼之間鏈接某種文檔,請將@uses標記放入測試用例的docblock中。這應該會導致@used-by標記自動出現在所測試方法/功能的文檔中。