PHP-kommentit, Sisällytä/Sisällytä_kerran, Vaadi/Vaadi

⚡ Älykäs yhteenveto

Kommentit, include, include_once, require ja require_once ovat keskeisiä PHP-työkaluja koodin dokumentointiin ja tiedostojen uudelleenkäyttöön. Tämä ohje selittää, miten yksi- ja moniriviset kommentit toimivat ja miten neljä tiedostojen sisällyttämislauseketta jakavat otsikot, valikot ja määritykset useille sivuille.

📝 Miksi kommentoida: Kommentit tallentavat koodin toiminnan, jotta sinä ja muut kehittäjät ymmärrätte sen myöhemmin; pyri noin kolmeen kommenttiriviin kymmentä koodiriviä kohden.
✏️ Kommentin syntaksi: Yksiriviset kommentit alkavat //-merkillä ja päättyvät rivinvaihtoon, kun taas usean rivin kommentit sijoittuvat /*- ja */-merkkien väliin.
📄 Sisällytä lauseke: include ja include_once vetävät toisen tiedoston nykyiseen skriptiin, mikä on ihanteellista jaetuille otsikoille ja navigointivalikoille.
🔒 Vaadittava lauseke: require ja require_once toimivat kuten include, mutta pysäyttävät skriptin virheen sattuessa, mikä sopii tärkeille tiedostoille, kuten tietokannan kokoonpanoille.
🔁 _once-variantit: include_once ja require_once ohittavat jo ladatun tiedoston, mikä estää päällekkäiset määrittelyt ja uudelleenmäärittelyvirheet.
🇧🇷 Sisällytä vs. vaadi: include vain varoittaa puuttuvasta tiedostosta ja jatkaa suoritusta, kun taas require heittää kohtalokkaan virheen ja pysäyttää suorituksen.
🤖 AI Assist: Tekoälytyökalut voivat luoda PHPDoc-kommentteja ja neuvoa, milloin tiedoston sisällyttäminen tai vaatiminen on turvallisempi vaihtoehto.

Lue lisää

Miksi käyttää kommentteja?

Jos et työskentele lähdekoodin parissa vähään aikaan, koodin toiminta unohtuu helposti. Lähdekoodin kommentointi auttaa sinua muistamaan, mitä koodi tekee.
Lähdekoodin kommentoiminen on myös erittäin tärkeää, kun useiden kehittäjien on työskenneltävä saman projektin parissa. Muut kehittäjät voivat helposti ymmärtää yhden kehittäjän tekemät muutokset lukemalla kommentit.
Parhaan käytännön mukaan sinulla tulisi olla kolme riviä kommentteja jokaista 10 riviä kohden koodia.

PHP kommentit

Kommentit auttavat meitä ymmärtämään koodin
Kommentit ovat selityksiä, jotka sisällytämme lähdekoodiimme. Nämä kommentit ovat ihmisten ymmärtämistä varten.
Yhden rivin kommentit alkavat kahdella vinoviivalla // ja ne päättyvät samalle riville.
Usean rivin kommentit alkavat vinoviivalla, jota seuraa tähdellä /* ja päättyvät tähdellä, jota seuraa vinoviiva */.

Alla oleva kaavio näyttää PHP-tiedoston, jossa on sekä monirivisiä että yksirivisiä kommentteja.

PHP esimerkki

PHP Include & PHP Include_once

PHP-tiedostoon sisällytetään muita tiedostoja PHP-tiedostoon, kun halutaan sisällyttää siihen muita tiedostoja.

Siitä on kaksi variaatiota, include ja include_once. PHP-tulkki jättää include_once-muuttujat huomiotta, jos sisällytettävä tiedosto on jo sisällytetty.

include-lauseella on seuraava syntaksi

<?php
include 'file_name';
?>

include_once-lauseella on seuraava syntaksi

<?php
include_once 'file_name';
?>

TÄSSÄ,

”include/include_once” on lauseke, joka sisällyttää tiedoston
”'tiedostonimi'” on sisällytettävän tiedoston nimi.

Esimerkki: Sisällytä / Sisällytä_once

Oletetaan, että olet kehittynytping verkkosivusto, jonka kaikilla sivuilla on sama navigointivalikko.

Voit luoda yhteisen otsikon ja sisällyttää sen jokaiselle sivulle käyttämällä include-lauseketta. Katsotaanpa, miten tämä onnistuu.

Luomme kaksi tiedostoa nimeltä
header.php, index.php

Alla on koodi kohteelle 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';

?>

Yllä oleva otsikkosivu näyttää navigointilinkit.

PHP Require & PHP Require_once

Reikälauseella on kaksi muunnelmaa, request ja request_once.

require/require_once-lausetta käytetään tiedoston sisällyttämiseen.

require_once-funktiota ei huomioida, jos vaadittu tiedosto on jo lisätty jollakin neljästä include-lauseesta.

Sillä on seuraava syntaksi

<?php
require 'file_name';
?>

<?php
require_once 'file_name';
?>

TÄSSÄ,

”require/require_once” on lauseke, joka sisältää tiedoston
”'tiedostonimi'” on sisällytettävän tiedoston nimi.

Esimerkki: Vaaditaan

Oletetaan, että olemme kehittymässäping tietokantapohjainen sovellus.

Voimme luoda konfigurointitiedoston, jonka voimme sisällyttää kaikille sivuille, jotka muodostavat yhteyden tietokantaan vaativan käskyn avulla. config.php

<?php

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

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

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

$config['password'] = '';

?>

Katsotaanpa nyt esimerkkikoodia, joka vaatii asetustiedoston. Sivut_malli.php

<?php

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

//other code for connecting to the database

?>

PHP sisältää vs vaadi

Sisällytä- ja vaadi-kommenttien välinen ero on esitetty alla.

Sisältää	Edellyttää
Antaa varoituksen, kun tapahtuu virhe	Antaa kohtalokkaan virheen
Komentosarjan suorittaminen jatkuu virheen sattuessa	Komentosarjan suoritus pysähtyy, kun tapahtuu virhe.

Yleisesti ottaen on suositeltavaa käyttää include-lauseketta, jotta virheen sattuessa komentosarja näyttää edelleen web-vastaavan sähköpostiosoitteen tai yhteydenottosivun.

Require-lausetta tulee käyttää, jos koko komentosarjaa ei voi suorittaa ilman pyydettyä tiedostoa.

”Sisällytä”- ja ”vaati”-lausekkeita voidaan käyttää millä tahansa lähdekoodin rivillä, jolla haluat koodin näkyvän.

PHP-dokumentaation kommentit (PHPDoc)

Yksi- ja monirivisten kommenttien lisäksi PHP-kehittäjät käyttävät PHPDoc-lohkokommentteja funktioiden ja luokkien dokumentointiin. PHPDoc-lohko alkaa /**-merkillä ja käyttää tageja, kuten @param ja @return, joita IDE-ympäristöt lukevat näyttääkseen vihjeitä ja täydentääkseen tekstiä automaattisesti.

<?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 ei muuta koodin suoritustapaa, mutta se tekee kunkin funktion tarkoituksen selkeäksi ja antaa työkalujen luoda API-dokumentaation automaattisesti. Sen lisääminen jaettuihin tiedostoihin, kuten yllä oleviin asetus- ja aputiedostoihin, pitää kasvavan koodikannan ylläpidettävänä.

UKK

Molemmat lataavat tiedoston vain kerran, vaikka niitä kutsuttaisiin uudelleen. Ero on virheiden käsittelyssä: include_once antaa varoituksen ja antaa komentosarjan jatkua, kun taas require_once heittää kohtalokkaan virheen ja pysäyttää suorituksen, jos tiedosto puuttuu.

Vain jos allow_url_include on käytössä php.ini-tiedostossa, mikä on oletuksena pois päältä turvallisuussyistä. Etätiedostojen sisällyttäminen on riskialtista, koska hyökkääjä voi lisätä koodia, joten paikallisia tiedostopolkuja suositaan vahvasti.

Ei. Palvelimen tulkki poistaa PHP-kommentit, joten ne eivät koskaan päädy selaimeen eivätkä näy sivun lähdekoodissa. Niiden vaikutus suorituskykyyn on käytännössä nolla.

Kyllä. Tekoäly voi funktion avulla luoda PHPDoc-lohkon, jossa on yhteenveto sekä @param- ja @return-tagit. RevTarkastele kuvauksia niin, että ne vastaavat tarkoitustasi, koska tekoäly päättelee merkityksen nimistä ja koodista.

Kyllä. Tekoäly voi tarkistaa jokaisen lisäyksen ja suositella vaatimuksia olennaisille tiedostoille, kuten määritystiedostoille, sekä lisätä valinnaisia tiedostoja, kuten ylimääräisen sivupalkin, selittäen kunkin virhekäyttäytymisen.

PHP-kommentit, Sisällytä/Sisällytä_kerran, Vaadi/Vaadi_kerran