如何记录PHPUnit测试

Question

我正在写很多单元测试，恐怕有一天我会回来阅读测试代码，不能理解测试的内容。

的问题是：我如何使用文件PHPDoc的PHPUnit的测试？

Answer 1

使用@covers注释（它特定于PHPUnit，而不是phpDocumentor使用的文档标记）来突出显示测试用例应该执行的操作。通过将它放在docblock中，您可以告诉代码阅读器测试所针对的代码。如果您的phpDocumentor也为您的测试用例生成文档，那么它应该将注释视为“自定义标签”，并将其显示为通用信息。但请注意，@covers的目的是限制PHPUnit完成的代码覆盖率测量。它作为doc信息使用是偶然的，但很有用。

如果您想要在测试用例和测试代码之间链接某种文档，请将@uses标记放入测试用例的docblock中。这应该会导致@used-by标记自动出现在所测试方法/功能的文档中。