Donate

Я с удовольствием и благодарностью приму маленькие пожертвования.

Подробнее »

Рекомендую

Как правильно писать комментарии в PHP?

В этой небольшой заметки мы рассмотрим три способа написания комментарий в PHP, а также я расскажу как правильно писать комментарии к своему коду.

(1) Комментарий в одну строчку в стиле языка "C" (обычно используют для отладки кода)

# это наш комментарий

(2) Комментарий в одну строчку

// это наш комментарий

(3) Многострочный комментарий

 /*
    Это наш длинный комментарий
    в котором мы рассказываем много всего...
 */

Видео урок по теме:

Как написать комментарии в PHP?

Когда и как нужно писать комментарии к коду?

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

(1) Лучше в краце описать что делает данный код и почему именно так.

(2) Хорошим тоном считаеться писать комментарии на английском языке.

(3) Комментарии всегда нужно писать к функциям и описывать в краце что она делает, какие аргументы принимает и что возвращает. Тоже самое относиться к классам, свойствам, методам...

(4) Если комментарий не убирается на одну строчку (макс. 180 симоволов), то лучше использовать многострочный комментарий.

(5). Лучше использовать один стиль написания комментарий (см. вариант 1 или вариант 2 в начале статьи)

(6) Комментарий нужно писать так, чтобы его поняли и другие разработчики, а не только вы.

В целом комментарии позволяет легко разобраться в коде, особенно спустя какое-то время, затратив на это минимальные усилия. Проверенно на практики!


У вас включён блокировщик рекламы (Adblocker, Adblocker Plus, uBlock).
Если вы хотите поддержать автора данного поста, пожалуйста выключите его!

Порекомендуйте эту статью друзьям:

Оставьте комментарий!

Если у Вас остались какие-либо вопросы, либо у Вас есть желание высказаться по поводу этой статьи, то Вы можете оставить свой комментарий:


Написать новый комментарий