О комментариях в коде.

Стандартно в PHP существует три типа комментариев:

//здесь комментарий

#здесь комментарий

/*Здесь многострочный

комментарий*/

Первые два ничем не отличаются и превращают в комментарий часть кода, которая идет после знаков # или // до конца текущей строки или до завершения PHP кода в зависимости от того, что начинается раньше.

Лично я предпочитаю многострочные комментарии, но это дело вкуса.

Для чего вообще нужны комментарии в коде?

Основных назначений у комментариев в коде два:

  1. Собственно комментирование. Для того, чтобы сделать восприятие кода более понятным стоит иногда указывать, что же было сделано и для чего. Встречал мнение, что комментариев в коде должно быть примерно треть от всего текста. Но встречал и противоположную точку зрения — комментариев должно быть минимальное количество, но структура кода и названия переменных должны подсказывать программисту, которому посчастливится работать с вашим кодом (да да, это можете оказаться и вы сами), что к чему. Думаю, золотая середина не помешает и в этом вопросе.
  2. Временное выключение из работы части кода. Если вы хотите чтобы какой-то кусок кода временно не работал, просто оградите его комментариями, и он не будет работать, а когда захотите вернуть просто уберите теги комментариев.

Интересные варианты комментирования в PHP

Одним из весьма занимательных способов комментирования является следующий:

 

/*
* Вот здесь пишем
* в комментариях и все в звездочках
* Сразу понятно как далеко комментарий идет и где заканчивается.
*/
//*
 Здесь кусок текста
 // */



Теперь нам достаточно убрать первую / и все — весь текст закомментирован, вернем / и закоментированными окажутся сами комментарии, а кусок кода будет работать.

/*
 Здесь кусок текста (и он работает)
 // */

2 комментария

  1. я в универе этих комментариев жесть как боялась) думала код перепорчу, но сейчас активно использую

Leave a Reply

Ваш e-mail не будет опубликован.