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

Навіщо використовувати коментарі?

• Якщо ви не працюєте з вихідним кодом протягом певного часу, легко забути, що він робить. Коментування вихідного коду допомагає вам запам'ятати, що він робить.
• Коментування вихідного коду також дуже важливо, коли кілька розробників працюють над одним проектом. Зміни, внесені одним розробником, можуть бути легко зрозумілі іншим розробникам, просто прочитавши коментарі.
• Як найкраща практика, у вас має бути 3 рядки коментарів на кожні 10 рядків коду.

Коментарі PHP

• Коментарі допомагають нам зрозуміти код
• Коментарі – це пояснення, які ми включаємо у вихідний код. Ці коментарі для людського розуміння.
• Однорядкові коментарі починаються з подвійної косої риски // і закінчуються в одному рядку.
• 
• Багаторядкові коментарі починаються з похилої риски, за якою йде зірочка /*, і закінчуються зірочкою, за якою йде похила риска */.
• 

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

Приклад PHP

PHP Include & PHP Include_once

Оператор PHP «include» використовується для включення інших файлів до PHP-файлу.

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

Оператор include має такий синтаксис

<?php
include 'file_name';
?>

Оператор include_once має такий синтаксис

<?php
include_once 'file_name';
?>

ТУТ,

• «include/include_once» – це оператор, який включає файл
• «'file_name'» – це ім’я файлу, який потрібно включити.

Приклад: Включити / Включити_один раз

Припустимо, ви розвиваєтесьping веб-сайт, який містить однакове меню навігації на всіх сторінках.

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

• Ми створимо 2 файли з назвами
• header.php, index.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'] = '';

?>

Давайте тепер розглянемо приклад коду, який вимагає конфігураційного файлу. Pages_model.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. Додавання його до спільних файлів, таких як файли конфігурації та допоміжні файли вище, забезпечує підтримку зростаючої кодової бази.

Поширені запитання