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

Комментировать свой код — это полезно не только для себя в будущем, но и для других кодеров, которые буду разбираться с вашим кодом. Комментарии могут убрать множество вопросов к самому программисту, так как многое уже объяснено. И PHP, как и многие другие языки, также имеет комментарии. И в данной статье мы подробно разберем, как комментировать на этом языке.

Введение

Комментарии на php схожи с комментариями на html. Если ввести определенные символы в определённой последовательности, а потом написать программу после этих символов, то интерпретатор просто не прочитает это, так как он знает, что это лишь комментарии. Такая же работа и во многих других языках. Поэтому для того, чтобы просмотреть комментарии нужно посмотреть сам код программы.

Уже было сказано, что php-комментарии похожи на html-комментарии. Но вот как выглядят комментарии, на самом html.

Однострочные комментарии

На html всего один тип комментариев, в то время как на php их два:

• однострочный
• многострочный

Сперва поговорим об однострочном типе. Интерпретатор будет игнорировать всё, что находится после специальных символов в области одной строки. Этими специальными символами являются “//” или “#”. После них идёт лишь текст незначащий ничего для интерпретатора. Если пишете код не в блокноте, то комментарии будут иметь серую окраску.

Результат:

Стоит обратить внимание, что некоторые команды, как на 2-ой строке echo не работает, потому что была закомментирована. Так тоже иногда делают для отладки, когда строку нужно временно удалить.

Многострочные комментарии

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

• /* — открывает
• */ — закрывает

Результат:

Ну и понятное дело, оба типа комментариев можно совмещать:

Результат:

Много комментариев — плохо

Действительно, комментарии были созданы, чтобы упрощать жизнь программистов, но если каждый кусочек кода вы объясняете, то это может значить и то, что ваш код просто не понятен.

Код, в котором не будет ничего лишнего будет понятен и без комментирования.

Поэтому вам стоит задуматься над написанием собственного кода, если комментарии в нем не просто нужны, а необходимы. В любом случае, в самих комментариях нет ничего плохого, пара-тройка комментариев не помешает, но перебарщивать и объяснять чуть-ли не всё — это плохо

Принцип комментирования

Как и было сказано, много комментариев не значит хорошо. Но важно в них прояснить несколько вещей:

• архитектура
• использование функций
• рациональность

Остановимся на последнем. Порой важно объяснить, почему так, а не иначе. Ваш коллега, да и вы через время, сможете спокойно понять, почему решение задачи было именно таким.

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

Во всём семействе C комментарии не отличаются. И хотя CSS не язык программирования он имеет точно такой же вид и такое же обозначение комментариев.

Для обозначения больших кусков кода используются слэши со звёздочкой:

• многострочные комментарии — /* */
• однострочные комментарии — //

Как видите, от php ничем не отличается.

Итог

Комментарии — это полезная вещь в языках программирования, хотя она есть и не только там, ещё например и в html с CSS.

Они упрощают жизнь программистов тем, что можно объяснить сложные блоки кода. Но комментировать свой код в каждом моменте — это плохо. Если код и без того понятен, то смысла в этом нет, в противном случае нужно просто его переделать.

Сам способ выражения комментариев не отличается друг от друга в разных языках программирования. Поэтому узнав комментарии в языке C++ — узнал комментарии во всём семействе C.

На этом всё, огромное спасибо за внимание. Интересных проектов и хорошего настроения!