PHP коментари, Включване/Включване_веднъж, Изискване/Изискване_веднъж

⚡ Умно обобщение

Коментарите, include, include_once, require и require_once са основни PHP инструменти за документиране на код и повторно използване на файлове. Това ръководство обяснява как работят едноредовите и многоредовите коментари и как четирите оператора за включване на файлове споделят заглавки, менюта и конфигурация на много страници.

  • 📝 Защо да коментирате: Коментарите записват какво прави кодът, за да можете вие ​​и другите разработчици да го разберете по-късно; стремете се към приблизително три реда коментари на всеки десет реда код.
  • ️ Синтаксис на коментара: Едноредовите коментари започват с // и завършват на края на реда, докато многоредовите коментари се намират между /* и */.
  • 📄 Включи изявление: include и include_once изтеглят друг файл в текущия скрипт, идеално за споделени заглавки и навигационни менюта.
  • 🔒 Изискване за декларация: require и require_once работят като include, но спират скрипта при неуспех, което е подходящо за важни файлове, като например конфигурацията на базата данни.
  • 🔁 Вариантите на _once: include_once и require_once пропускат файл, който вече е зареден, предотвратявайки дублиращи се декларации и грешки при предефиниране.
  • ️ Включване срещу Задължително: include само предупреждава и продължава при липсващ файл, докато require хвърля фатална грешка и спира изпълнението.
  • 🤖 AI Assist: Инструментите с изкуствен интелект могат да генерират коментари в PHPDoc и да съветват кога include или require е по-безопасният избор за даден файл.

PHP коментари, включване и изискване

Защо да използвате коментари?

  • Ако не работите върху изходния код известно време, е лесно да забравите какво прави той. Коментирането на изходния код ви помага да запомните какво прави той.
  • Коментирането на изходния код също е много важно, когато няколко разработчици трябва да работят по един и същи проект. Промените, направени от един разработчик, могат лесно да бъдат разбрани от други разработчици, като просто прочетат коментарите.
  • Като най-добра практика, трябва да имате 3 реда коментари за всеки 10 реда код.

PHP коментари

  • Коментарите ни помагат да разберем кода
  • Коментарите са обяснения, които включваме в нашия изходен код. Тези коментари са за човешкото разбиране.
  • Едноредовите коментари започват с двойни наклонени черти // и завършват на един и същи ред.
  • PHP коментари
  • Многоредовите коментари започват с наклонена черта, последвана от звездичката /* и завършват със звездичката, последвана от наклонената черта */.
  • PHP коментари

Диаграмата по-долу показва PHP файл с коментари от няколко реда и от един ред.

Пример за PHP

Пример за PHP коментари

PHP Include & PHP Include_once

PHP операторът „include“ се използва за включване на други файлове в PHP файл.

Има два варианта, include и include_once. include_once се игнорира от PHP интерпретатора, ако файлът, който ще бъде включен, вече е включен.

Операторът за включване има следния синтаксис

<?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_once.

Изразът require/require_once се използва за включване на файл.

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

Има следния синтаксис

<?php
require 'file_name';
?>
<?php
require_once 'file_name';
?>

ТУК,

  • „require/require_once“ е операторът, който включва файла
  • „'file_name'“ е името на файла, който ще бъде включен.

Пример: Изискване

Да предположим, че се развивамеping приложение, задвижвано от база данни.

Можем да създадем конфигурационен файл, който можем да включим във всички страници, които се свързват с базата данни, използвайки израза за изискване. 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, така че когато възникне грешка, изпълнението на скрипта да продължи да показва имейл адреса на уеб администратора или страницата за контакт.

Инструкцията за изискване трябва да се използва, ако целият скрипт не може да се изпълнява без искания файл.

Изразите „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 документация. Добавянето му към споделени файлове, като например конфигурационните и помощните файлове по-горе, поддържа нарастващата кодова база лесна за поддръжка.

Въпроси и Отговори

И двата метода зареждат файл само веднъж, дори ако бъде извикан отново. Разликата е в обработката на грешки: include_once издава предупреждение и позволява на скрипта да продължи, докато require_once хвърля фатална грешка и спира изпълнението, ако файлът липсва.

Само ако allow_url_include е активирано в php.ini, което е изключено по подразбиране от съображения за сигурност. Включването на отдалечени файлове е рисковано, защото атакуващ може да инжектира код, така че локалните файлови пътища са силно за предпочитане.

Не. PHP коментарите се премахват от интерпретатора на сървъра, така че никога не достигат до браузъра и не се виждат в изходния код на страницата. Тяхното влияние върху производителността е практически нулево.

Да. Като се има предвид функция, изкуственият интелект може да генерира PHPDoc блок с обобщение плюс тагове @param и @return. RevПрегледайте описанията така, че да съответстват на вашето намерение, тъй като изкуственият интелект извежда значение от имена и код.

Да. Изкуственият интелект може да прегледа всяко включване и да препоръча изискване за основни файлове, като например конфигурация, и да включи незадължителни, като например допълнителна странична лента, обяснявайки поведението при неуспех на всяко от тях.

Обобщете тази публикация с: