Komentarze PHP, Dołącz/Dołącz_raz, Wymagaj/Wymagaj_raz

Dlaczego warto korzystać z komentarzy?

• Jeśli przez jakiś czas nie pracujesz nad kodem źródłowym, łatwo jest zapomnieć, do czego służy. Komentarze do kodu źródłowego pomagają zapamiętać jego działanie.
• Komentowanie kodu źródłowego jest również bardzo ważne, gdy wielu programistów musi pracować nad tym samym projektem. Zmiany wprowadzone przez jednego programistę mogą być łatwo zrozumiałe dla innych programistów, po prostu czytając komentarze.
• Dobrą praktyką jest umieszczanie 3 linijek komentarzy na każde 10 linijek kodu.

Komentarze PHP

• Komentarze pomagają nam zrozumieć kod
• Komentarze to wyjaśnienia, które umieszczamy w naszym kodzie źródłowym. Te komentarze służą ludzkiemu zrozumieniu.
• Komentarze jednowierszowe zaczynają się podwójnymi ukośnikami // i kończą się w tym samym wierszu.
• 
• Komentarze wieloliniowe zaczynają się od ukośnika, po którym następuje gwiazdka /* i kończą się gwiazdką, po której następuje ukośnik */.
• 

Poniższy diagram przedstawia plik PHP z komentarzami jedno- i wielowierszowymi.

Przykład PHP

PHP Dołącz & PHP Dołącz_raz

Polecenie PHP „include” służy do dołączania innych plików do pliku PHP.

Posiada dwie odmiany, include i include_once. Opcja include_once jest ignorowana przez interpreter PHP, jeśli plik, który ma zostać dołączony, został już dołączony.

Polecenie include ma następującą składnię

<?php
include 'file_name';
?>

Polecenie include_once ma następującą składnię

<?php
include_once 'file_name';
?>

TUTAJ,

• „include/include_once” to polecenie obejmujące plik
• „'file_name'” to nazwa pliku, który ma zostać uwzględniony.

Przykład: Include / Include_once

Załóżmy, że jesteś rozwijanyping witryna internetowa zawierająca to samo menu nawigacyjne na wszystkich stronach.

Możesz utworzyć wspólny nagłówek, a następnie dołączyć go do każdej strony za pomocą polecenia include. Zobaczmy, jak to zrobić.

• Utworzymy 2 pliki o nazwach
• nagłówek.php, indeks.php

Poniżej znajduje się kod dla 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';

?>

Nagłówek powyższej strony będzie zawierał łącza nawigacyjne.

PHP Wymagaj i PHP wymagaj_raz

Instrukcja require ma dwie odmiany: require i require_once.

Polecenie require/require_once służy do dołączenia pliku.

require_once jest ignorowane, jeśli wymagany plik został już dodany za pomocą któregokolwiek z czterech poleceń include.

Ma następującą składnię

<?php
require 'file_name';
?>

<?php
require_once 'file_name';
?>

TUTAJ,

• „require/require_once” to polecenie obejmujące plik
• „'file_name'” to nazwa pliku, który ma zostać uwzględniony.

Przykład: Wymagaj

Załóżmy, że jesteśmy rozwinięciping aplikacja oparta na bazie danych.

Możemy utworzyć plik konfiguracyjny, który będziemy mogli dołączyć do wszystkich stron łączących się z bazą danych za pomocą instrukcji require. config.php

<?php

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

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

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

$config['password'] = '';

?>

Przyjrzyjmy się teraz przykładowemu kodowi, który wymaga pliku konfiguracyjnego. Strony_model.php

<?php

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

//other code for connecting to the database

?>

PHP zawiera vs wymaga

Różnicę między poleceniami include i require pokazano poniżej.

Ogólnie rzecz biorąc, zaleca się użycie polecenia include, aby w razie wystąpienia błędu wykonywanie skryptu nadal wyświetlało adres e-mail webmastera lub stronę kontaktową.

Jeśli nie można uruchomić całego skryptu bez żądanego pliku, należy użyć instrukcji require.

Polecenia „include” i „require” można stosować w dowolnym wierszu kodu źródłowego, w którym ma się on pojawić.

Komentarze do dokumentacji PHP (PHPDoc)

Oprócz komentarzy jedno- i wielowierszowych, programiści PHP używają komentarzy blokowych PHPDoc do dokumentowania funkcji i klas. Blok PHPDoc zaczyna się od /** i używa tagów takich jak @param i @return, które środowiska IDE odczytują do wyświetlania podpowiedzi i autouzupełniania.

<?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 nie zmienia sposobu działania kodu, ale jasno określa przeznaczenie każdej funkcji i pozwala narzędziom automatycznie generować dokumentację API. Dodanie go do współdzielonych plików, takich jak pliki konfiguracyjne i pomocnicze powyżej, ułatwia zarządzanie rosnącą bazą kodu.

FAQ