Комментарии PHP, Include/Include_once, Require/Require_once

Зачем использовать комментарии?

• Если вы какое-то время не работаете с исходным кодом, легко забыть, что он делает. Комментирование исходного кода помогает вспомнить, что он делает.
• Комментирование исходного кода также очень важно, когда над одним проектом работают несколько разработчиков. Изменения, внесенные одним разработчиком, могут быть легко поняты другими разработчиками, просто прочитав комментарии.
• В качестве оптимальной практики рекомендуется размещать 3 строки комментариев на каждые 10 строк кода.

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

• Комментарии помогают нам понять код
• Комментарии — это пояснения, которые мы включаем в наш исходный код. Эти комментарии предназначены для человеческого понимания.
• Однострочные комментарии начинаются с двойных косых черт // и заканчиваются на той же строке.
• 
• Многострочные комментарии начинаются с косой черты, за которой следует звездочка /*, и заканчиваются звездочкой, за которой следует косая черта */.
• 

На приведенной ниже диаграмме показан PHP-файл, содержащий как многострочные, так и однострочные комментарии.

Пример PHP

PHP Include и PHP Include_once

Оператор `include` в PHP используется для включения других файлов в PHP-файл.

Существует два варианта: include и include_once. include_once игнорируется интерпретатором PHP, если файл, который необходимо включить, уже был включен.

Оператор включения имеет следующий синтаксис

<?php
include 'file_name';
?>

Инструкция include_once имеет следующий синтаксис

<?php
include_once 'file_name';
?>

ВОТ,

• “include/include_once” — это команда, которая включает файл.
• «'file_name'» — это имя файла, который необходимо включить.

Пример: Include / Include_once

Предположим, вы разработчикping Веб-сайт, на всех страницах которого используется одно и то же навигационное меню.

Вы можете создать общий заголовок, а затем включить его на каждой странице с помощью оператора include. Давайте посмотрим, как это можно сделать.

• Мы создадим 2 файла с именами
• заголовок.php, индекс.php

Ниже приведён код для header.php

<a href="index.php">Home</a>

<a href="aboutus.php">About us</a>

<a href="services.php">Services</a>

<a href="contactus.php">Contact Us</a>

index.php

<?php

include 'header.php';

?>

На странице заголовка, расположенной выше, будут отображены навигационные ссылки.

PHP Require и PHP require_once

Оператор require имеет два варианта: require и require_once.

Оператор require/require_once используется для включения файла.

Параметр require_once игнорируется, если необходимый файл уже был добавлен каким-либо из четырех операторов include.

Он имеет следующий синтаксис

<?php
require 'file_name';
?>

<?php
require_once 'file_name';
?>

ВОТ,

• “require/require_once” — это инструкция, которая включает файл.
• «'file_name'» — это имя файла, который необходимо включить.

Пример: Требуется

Предположим, мы разрабатываемping Приложение, работающее на основе базы данных.

Мы можем создать файл конфигурации, который можно будет включить на все страницы, подключающиеся к базе данных, с помощью оператора require. config.php

<?php

$config['host'] = 'localhost';

$config['db'] = 'my_database';

$config['uid'] = 'root';

$config['password'] = '';

?>

Теперь давайте рассмотрим пример кода, для работы которого требуется файл конфигурации. Страницы_модель.php

<?php

require 'config.php'; //require the config file

//other code for connecting to the database

?>

PHP включает или требует

Разница между include и require показана ниже.

Как правило, рекомендуется использовать оператор include, чтобы при возникновении ошибки выполнение скрипта продолжалось с отображением адреса электронной почты веб-мастера или страницы "Контакты".

Оператор require следует использовать, если весь сценарий не может работать без запрошенного файла.

Операторы «include» и «require» можно использовать в любой строке исходного кода, где вы хотите разместить этот код.

Комментарии к документации PHP (PHPDoc)

Помимо однострочных и многострочных комментариев, PHP-разработчики используют блочные комментарии PHPDoc для документирования функций и классов. Блок PHPDoc начинается с /** и использует теги, такие как @param и @return, которые IDE считывают для отображения подсказок и автозаполнения.

<?php
/**
 * Adds two numbers together.
 *
 * @param int $a The first number
 * @param int $b The second number
 * @return int The sum of the two numbers
 */
function add($a, $b) {
    return $a + $b;
}
?>

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

Часто задаваемые вопросы (FAQ)