作者:V陈冬梅_717 | 来源:互联网 | 2023-01-26 17:02
我正在编写很多单元测试,恐怕有一天我会回来阅读测试代码,而无法理解所测试的内容。
问题是:如何使用PHPDoc记录PHPUnit测试?
1> ashnazg..:
使用@covers
注释(特定于PHPUnit,而不是phpDocumentor使用的文档标记)来突出显示测试用例应执行的操作。通过将其放在docblock中,您可以告诉代码读取器测试所针对的代码。如果您有phpDocumentor也为您的测试用例生成文档,则它应将注释视为“自定义标签”,并将其显示为常规信息。但是请注意,关键@covers
是要限制PHPUnit完成的代码覆盖率测量。用作文档信息是偶然的,但很有用。
如果要在测试用例和经过测试的代码之间建立某种文档链接,请将@uses
标记放在测试用例的docblock中。这将导致@used-by
标记自动出现在经过测试的方法/功能的文档中。