Есть ли соглашение в PHP, чтобы отметить, где функция выполняется в тестах?

Question

У нас уже есть reverse convention, где в тестовом док-блоке phpUnit нормально использовать аннотацию @covers.

Если вы смотрите на кусочек кода, часто полезно посмотреть на тесты, которые выполняют эту логику, чтобы понять, что должен делать код. В PHP существует ли соглашение для документирования в вашем коде, где можно найти тесты, которые были написаны для выполнения функции? Если нет, то мы планируем принять нашу собственную конвенцию и рассматриваем один из следующих вариантов:

• Используйте phpDocumentor @internal annotation
• использовать полностью настраиваемую аннотацию как @spec
• просто свободный комментарий в DocBlock, но стилизованный в быстро узнаваемом шаблоне
• не документируйте, но узнайте, где он протестирован, закомментировав код, запустите набор тестов и посмотрите, какие тесты терпят неудачу.

Есть ли предупреждения относительно использования любого из них?

Answer 1

Вопрос в том, зачем вам это нужно? Кто-нибудь будет читать эти аннотации? Вы должны запускать все свои тесты так часто, как это возможно, и если вы запустите их с возможностью проверки покрытия, вы увидите, что покрывается тестами, а что нет.

Если вы хотите использовать это только для навигации в своей среде IDE, возможно, вы можете использовать сочетание клавиш для этого. То есть Я работаю на OSX с PHPStorm, и я использую CMD + SHIFT + T для перехода между тестами и проверенным кодом.