Есть ли в PHP соглашение о том, что функция выполняется в тестах?
У нас уже есть обратное соглашение где в тестовом док-блоке phpUnit нормально использовать @covers аннотаций.
Если вы смотрите на фрагмент кода, часто полезно посмотреть на тесты, которые используют эту логику, чтобы понять, что должен делать код. В PHP есть соглашение для документирования в вашем коде, где найти тесты, которые были написаны для выполнения функции? Если нет, мы планируем принять нашу собственную конвенцию и рассматриваем один из следующих вариантов:
- использовать PhpDocumentor
@internalаннотирование - использовать полностью настраиваемую аннотацию, например
@spec - просто бесплатный комментарий в докблоке, но в стиле быстрого узнаваемого шаблона
- не документируйте, а узнайте, где он тестируется, закомментировав код, запустите набор тестов и посмотрите, какие тесты не пройдены.
Есть ли какие-либо предупреждения против использования любого из них?
Решение
Вопрос в том, зачем вам это нужно? Кто-нибудь собирается читать эти аннотации? Вы должны запускать все свои тесты настолько часто, насколько это возможно, и если вы будете запускать их с опцией покрытия тестами, вы увидите, что покрыто тестами, а что нет.
Если вы хотите использовать это только для навигации в вашей IDE, возможно, вы можете использовать сочетание клавиш для достижения этой цели. То есть Я работаю на OSX с PHPStorm и использую CMD + SHIFT + T для навигации между тестами и проверенным кодом.
Другие решения
Других решений пока нет …