我们已经有了相反的约定,在phpUnit测试文档块中,使用@covers
注释是正常的。
如果你正在查看一段代码,那么查看执行该逻辑的测试通常会很有帮助,以了解代码应该做什么。在PHP中,有没有一个惯例可以在代码中记录,在哪里可以找到为执行该函数而编写的测试?如果没有,我们计划采用我们自己的公约,并正在考虑其中一种选择:
- 使用phpDocumentor
@internal
注释 - 使用完全自定义的注释,如
@spec
- 只是文档块中的一条免费评论,但采用了可快速识别的模式
- 不要编写文档,而是通过注释代码来找出测试的位置,运行测试套件并查看哪些测试失败
是否有任何禁止使用这些的警告?
问题是为什么你需要这个?有人会读那些注释吗?您应该尽可能频繁地运行所有测试,如果您使用测试覆盖选项来运行它们,您将看到哪些测试覆盖了,哪些没有覆盖。
如果您只想使用它在IDE中导航,也许您可以使用键盘快捷键来实现这一点。也就是说,我用PHPStorm在OSX上工作,我使用CMD+SHIFT+T在测试和测试代码之间导航。