Комментарии в PHP

Я тут книжечки по пхп начал читать, как ранее писал. Ну и естественно, будучи PHP разработчиком с восьмилетним стажем, разработавшим с нуля штук пять CMS и под сотню разных скриптов и модулей и входящий в TOP 30% PHP разработчиков по тестам UpWork'a, я нахожу для себя много чего нового в книгах "PHP for Beginners", начиная прямо с глав "Language Basics". Чем и буду изредка делиться.

Сейчас - о комментариях в PHP.
Комментариев всего три вида, шеловские:

Си-плюс-плюсные:

И сишные:

Ну это понятно. Другое дело, что, внезапно, терминатором шеловских и С++ комментариев (# и // соответственно) является не только окончание строки, но и окончание блока PHP кода.

Т. е. следующие примеры кода полностью валидны:

Some text. Some text.

А я-то раньше использовал для вставки пхп-сниппетов в HTML исключительно сишные комментарии:

Some text.

Целых три лишних символа! Теперь вот буду знать.

Ну и да, для /* */ окончанием комментария служит исключительно */, т. е. вот это:

Some text.

выкинет ожидаемую ошибку, дескать, Warning: Unterminated comment и все такое.

Автор, загугли docBlock comments или phpDoc. Можно открыть много нового =)

К сожалению, ничего нового не открыл(

Лет пять уже так комментарии форматирую, но честно признаюсь - доки к пхпДок не читал, а всегда отталкивался от Drupal Coding standards, а у них не совсем нативный phpDoc,

The API module parses documentation and code in PHP files, and it expects documentation to be in a format similar to other code/documentation parsing systems such as PHPDoc, JavaDoc, etc. It was originally based on Doxygen, but it has evolved into something that has its own set of tags and a lot of Drupal-specific functionality.

Но соглашусь, документацию к phpDoc зачесть не помешает, чем и постараюсь заняться как только так сразу. Спасибо за напоминание, а то так руки вообще никогда не дошли бы скорее всего.

Добавить комментарий

Содержимое данного поля является приватным и не предназначено для показа.