Время чтения ~ 30 сек. / 29 просмотров / 0 комментариев / Декабрь 30, 2023, 23:55

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

Комментарии — важная часть кода. Комментарии предоставляют полезную информацию, которая поможет вам и другим разработчикам позже быстрее понять смысл кода.

PHP поддерживает два типа комментариев:

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

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

Однострочный комментарий размещается в конце строки или в текущем блоке.

Однострочный комментарий начинается с решетки (#) или двойной косой черты (//). Остальная часть текста после (//) игнорируется интерпретатором PHP.

В следующем примере используется // для однострочного комментария:

<?php

$rate = 100;
$hours = 173;
$payout = $hours * $rate; // расчет выплат

А в следующем примере используется # для однострочного комментария:

<?php

$title = 'PHP комментарий'; # устанавливаем заголовок по умолчанию

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

Многострочный комментарий начинается с /* и заканчивается */. Например:

<?php
/*
    Это пример многострочного комментария,
    который может охватывать несколько строк.
*/

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

Написание содержательных комментариев

Для эффективного документирования кода используйте следующие рекомендации:

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

    $is_completed = true;

    Вместо использования загадочного имени с комментарием:

    $ic = true; // is completed

    Сам код может быть хорошим комментарием.

  2. Не пишите комментарий, объясняющий, что делает код, вместо этого объясните, почему он это делает. Например:

// выполнить задачу
$is_completed = true;
  1. При написании комментария делайте его максимально кратким.

Подытожим

  • Комментарии являются важной частью кода, поскольку они объясняют, почему код делает то, что должен делать.
  • PHP поддерживает как однострочные, так и многострочные комментарии.
  • Однострочный комментарий начинается с # или //.
  • Многострочный комментарий начинается с /* и заканчивается */.
Теги:
php
Переменные в PHP
Константы в PHP
Синтаксис PHP
Декабрь 28, 2023, 23:29
В этом уроке вы изучите базовый синтаксис PHP, включая чувствительность к регистру, инструкции и пробелы.
Логический тип (Boolean) - PHP
Январь 05, 2024, 15:41
В этом уроке вы узнаете о логическом типе данных и логических значениях PHP.
Операторы сравнения - PHP
Январь 10, 2024, 17:48
В этом уроке вы узнаете, как использовать операторы сравнения в PHP для сравнения двух значений.
Типы данных - PHP
Январь 04, 2024, 15:06
В этом руководстве вы узнаете о типах данных PHP, такие как скалярные, составные и специальные типы.
Привет, Мир! на PHP
Декабрь 27, 2023, 22:33
В этом уроке вы узнаете, как выполнить сценарий, который выводит сообщение "Привет, Мир!" в веб-браузере и в командной строке.