PHP中是否有一个约定来说明在测试中执行函数的位置?

时间:2016-07-22 14:32:33

标签: php conventions docblocks

我们已经有reverse convention在phpUnit测试docblock中使用@covers注释是正常的。

如果您正在查看一段代码,那么查看运行该逻辑的测试通常有助于理解代码应该执行的操作。在PHP中,是否有一个约定在您的代码中记录在哪里找到为执行该函数而编写的测试?如果没有,我们计划采用我们自己的公约,并考虑其中一个选择:

  • 使用phpDocumentor @internal annotation
  • 使用完全自定义的注释,例如@spec
  • 只是docblock中的免费评论,但以快速识别的格式设置
  • 不要记录,但要通过注释掉代码找出测试位置,运行测试套件并查看哪些测试失败。

是否有任何警告禁止使用其中任何一种?

1 个答案:

答案 0 :(得分:0)

问题是为什么你需要这个?有人会阅读那些注释吗?您应该尽可能频繁地运行所有测试,如果您将使用测试覆盖率选项运行它们,您将看到测试覆盖的内容和不测试的内容。

如果您只想使用它在IDE中导航,也许您可​​以使用键盘快捷键来实现此目的。即我使用PHPStorm在OSX上工作,我使用CMD + SHIFT + T在测试和测试代码之间导航。