Это обычная проблема в командах разработчиков программного обеспечения. DocBlock будет записан во время первоначального создания метода. Затем метод меняется, и DocBlock оказывается устаревшим и неточным.
Если есть простой способ сообщить моему CI-конвейеру (или даже git-хуку), что DocBlock находится в опасность быть неточным, я бы хотел это сделать. Если такого инструмента нет, я хотел бы создать его как небольшой побочный проект.
===
РЕДАКТИРОВАТЬ 1: Я надеясь показать, когда изменился немашиночитаемый комментарий. Для этого можно использовать теги @since и @version, но в идеале мне бы хотелось, чтобы отображалась дата или отдельный коммит, поскольку они были бы более детальными. Таким образом, мой конвейер в идеале мог бы проверить, был ли обновлен удобочитаемый комментарий при обновлении соответствующего метода, и жаловаться, если нет.
EDIT 2: Вот пример тип комментария, статус которого я хотел бы проверить. (Комментарий ниже явно устарел.)
Код: Выделить всё
/**
* We use SomeArbitraryClass::SOME_CONSTANT and not
* SomeOtherArbitraryClass::SOME_CONSTANT because the
* hoobstork is blimmy blammied on the gargle blaster until 2021.
*/
public function handleSqs(SqsEvent $event, Context $context): void
{
$counter = 0;
foreach ($event->getRecords() as $record) {
if ($counter < SomeOtherArbitraryClass::SOME_CONSTANT) {
$this->handlingService->doHandle($record);
}
$counter++;
}
}
Подробнее здесь: https://stackoverflow.com/questions/793 ... -docblocks
Мобильная версия