我们已经有了相反的约定,在 phpUnit 测试文档块中使用@covers
注释是正常的。
如果您正在查看一段代码,那么查看执行该逻辑的测试通常会有所帮助,以了解代码应该做什么。在 PHP 中,是否有约定在您的代码中记录在哪里可以找到为执行该功能而编写的测试?如果没有,我们计划采用我们自己的约定并正在考虑以下选项之一:
- 使用phpDocumentor
@internal
注释 - 使用完全自定义的注释,例如
@spec
- 只是 docblock 中的一个免费评论,但样式以快速可识别的模式
- 不要记录,而是通过注释代码找出测试的位置,运行测试套件并查看哪些测试失败。
是否有任何警告不要使用这些?