Что такое «комментарии в стиле PHPDo c»? - PullRequest
0 голосов
/ 16 февраля 2020

Злой, противный жук укусил меня сегодня. Долгое время я рассчитывал количество «чистых» строк исходного кода PHP из сценариев PHP. Чтобы выполнить это sh, я перебрал все токены и удалил любой экземпляр T_COMMENT.

В руководстве на https://www.php.net/manual/en/tokens.php написано:

T_COMMENT   // or #, and /* */  comments

Оказывается, это не удалило какой-то необычный комментарий в альтернативном стиле, который, по-видимому, называется "комментарии в стиле PHPDo c". На той же странице, внизу (которую я никогда не искал, потому что я понятия не имел, что они существуют), написано:

T_DOC_COMMENT   /** */  PHPDoc style comments

Теперь мой код работает, потому что я учитываю оба вида.

Однако мне все еще интересно, что такое «комментарий в стиле PHPDo c», и почему они не считаются частью T_COMMENT.

К сожалению, комментарии в стиле «PHPDo c» «Гиперссылка на этой странице руководства просто ссылается на общую c страницу« комментариев », где нигде не упоминается« PHPDo c »!

Итак, что это? Почему это считается особенным видом комментариев? Почему это не задокументировано? Почему все в этой жизни должно быть полной чертовой тайной?!

1 Ответ

0 голосов
/ 16 февраля 2020

Подобные комментарии используются для чтения инструментами документации, которые анализируют ваш исходный код и генерируют документацию о ваших функциях и классах. Например, phpDocumentor - это такой инструмент для генерации документации, похожий на javado c.

...