Как делать комментарии на PHP

Комментарий – это вид примечания, которое может быть использовано для пояснения цели и значения фрагмента кода. Работая в PHP, у вас будет несколько вариантов написания комментариев, которые пошли от старых известных языков программирования: путем ввода однострочных или многострочных С-комментариев. Вы можете использовать комментарии, чтобы не дать фрагменту кода заработать или просто для ведения записей.

Часть 1

Часть 1 из 2:

Стили

Загрузить PDF

1
Однострочные комментарии для коротких записей. Если вам необходимо оставить короткий комментарий, воспользуйтесь кодом для однострочного комментария. Комментарий протянется лишь до конца линии или конца блока кода. Такие комментарии работают лишь внутри меток PHP и будут прочтены только, если поместить их в HTML.^{[1]XИсточник информации}
```
 <?php // Это стандартный (С++) способ создания однострочного комментария # Для создания однострочного комментария вы также можете воспользоваться этим стилем Unix   ?>
```
2
Для написания длинных комментариев или тестирования кода воспользуйтесь многострочными комментариями. Многострочные комментарии очень полезны при написании длинных объяснений и для предотвращения обработки сегмента кода. Прочитайте раздел «Использование», чтобы узнать о некоторых советах по использованию «многострочных комментариев.^{[2]XИсточник информации}
```
 <?php /* Вот как стоит форматироватьмногострочный комментарий. Весь текстдо конца метки будет включенв комментарий *//* Некоторым нравится включать* в начало каждой линии* дополнительные маркеры. Это улучшит* читабельность больших комментариев, хотя и не является обязательным. */ ?>
```
Реклама

Часть 2

Часть 2 из 2:

Использование

Загрузить PDF

1
Используйте комментарии для оставления заметок по работоспособности кода. Вы не обязаны это делать для каждой линии кода, так как другие программисты без труда разберутся в хорошо написанном коде. Комментарии полезны в том случае, если код выполняет нестандартные или не очевидные функции.^{[3]XИсточник информации}
```
// Создайте запрос curl$session = curl_init($request);// Скажите curl воспользоваться HTTP POSTcurl_setopt ($session, CURLOPT_POST, true);
```
2
Оставляйте комментарии, чтобы не забыть, что вы делали с кодом. При работе над проектом комментарии не дадут вам забыть, на чем вы остановились. Оставьте комментарии для кода, который неправильно работает или который вы еще не закончили.
```
// Перед тем, как перейти к следующему шагу, необходимо перепроверить результат этой программыecho "Hello World!";
```
3
Оставьте комментарий для кода, которым вы планируете поделиться. Если вы планируете сотрудничать другими программистами или собираетесь сделать свой код общедоступным, комментарии помогут другим понять, как ваш код работает и что следует поправить.^{[4]XИсточник информации}
```
/* Есть ли более эффективный способ это выполнить?*/Gender:<input type="radio" name="gender"<?php if (isset($gender) && $gender=="female") echo "checked";?>value="female">Female<input type="radio" name="gender"<?php if (isset($gender) && $gender=="male") echo "checked";?>value="male">Male
```
4
Оставляйте комментарии для отмены работы конкретных блоков кода. Это довольно полезно, когда вы тестируете код и хотите остановить работу какого-то его фрагмента. При запуске страницы все, что включено в метку комментария, будет игнорироваться.
```
 <?php echo "/*Hello*/ World!"; /* При запуске вышеупомянутого кода слово «Hello» отражено не будет */  ?>
```
5
Будьте осторожны при комментировании больших блоков кода. Функция комментирования закончится тогда, когда заработает первая метка завершения, поэтому если внутри кода, который вы уже комментировали, находится многострочный комментарий, он протянется лишь до начала первоначального комментария.
```
 <?php  /* echo "Hello World!"; /* Этот комментарий все испортит */*/ ?>
```
```
 <?php  /* echo "Hello World!"; // С этим комментарием все будет хорошо*/ ?>
```

How.com.vn Русский: Step 6 Воспользуйтесь комментариями для создания псевдозаписей.

Вы можете воспользоваться некоторыми креативными форматами кодов для создания записи для кода прямо внутри него. Это довольно полезно для общедоступных проектов.

 <?php  //============= // ЗАГОЛОВОК //=============  //------------- // Подзаголовок //-------------  /* Название раздела */ # Записи можно написать сюда# Вторую часть можно написать сюда  /* * Воспользуйтесь этим для объяснения того, * для чего понадобится несколько линий  * или даже несколько пунктов объяснения */  ?>

Советы

Комментарии HTML и PHP отличаются друг от друга, поэтому при работе со сценариями (сочетание HTML и PHP), убедитесь, что используете правильный синтаксис.
Например, в следующем коде находится комментарий HTML, но он все равно выполняет код PHP. Если вы поместите комментарий HTML внутри метки PHP, это приведет к ошибке.
-