PHP-kommentarer, Inkluder/Inkluder_en gang, Krev/Krev_en gang

Hvorfor bruke kommentarer?

• Hvis du ikke jobber med kildekoden på en stund, er det lett å glemme hva koden gjør. Å kommentere kildekoden hjelper deg å huske hva koden gjør.
• Å kommentere kildekoden er også veldig viktig når flere utviklere må jobbe med samme prosjekt. Endringene gjort av en utvikler kan lett forstås av andre utviklere ved ganske enkelt å lese kommentarene.
• Som en god praksis bør du ha 3 linjer med kommentarer for hver 10 linjer med kode.

PHP-kommentarer

• Kommentarer hjelper oss å forstå koden
• Kommentarer er forklaringer som vi inkluderer i kildekoden vår. Disse kommentarene er for menneskelig forståelse.
• Kommentarer på én linje starter med doble skråstreker // og slutter på samme linje.
• 
• Kommentarer på flere linjer starter med en skråstrek etterfulgt av stjernen /* og slutter med stjernen etterfulgt av skråstreken */.
• 

Diagrammet nedenfor viser en PHP-fil med kommentarer på både flere linjer og én linje.

PHP eksempel

PHP Include & PHP Include_once

PHP-setningen «include» brukes til å inkludere andre filer i en PHP-fil.

Den har to varianter, include og include_once. include_once ignoreres av PHP-tolkeren hvis filen som skal inkluderes allerede er inkludert.

Inkluder-setningen har følgende syntaks

<?php
include 'file_name';
?>

include_once-setningen har følgende syntaks

<?php
include_once 'file_name';
?>

HER,

• «include/include_once» er setningen som inkluderer filen
• «'filnavn'» er navnet på filen som skal inkluderes.

Eksempel: Inkluder / Inkluder_én gang

Anta at du er utvikletping et nettsted som inneholder den samme navigasjonsmenyen på tvers av alle sidene.

Du kan opprette en felles overskrift og deretter inkludere den på hver side ved hjelp av include-setningen. La oss se hvordan dette kan gjøres.

• Vi lager to filer med navnet
• header.php, index.php

Nedenfor er koden for 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';

?>

Toppsiden ovenfor vil vise navigasjonslenkene.

PHP Require & PHP require_once

Require-setningen har to varianter, require og require_once.

require/require_once-setningen brukes til å inkludere en fil.

require_once ignoreres hvis den nødvendige filen allerede er lagt til av en av de fire include-setningene.

Den har følgende syntaks

<?php
require 'file_name';
?>

<?php
require_once 'file_name';
?>

HER,

• «require/require_once» er setningen som inkluderer filen
• «'filnavn'» er navnet på filen som skal inkluderes.

Eksempel: Krev

Anta at vi er utvikledeping en databasedrevet applikasjon.

Vi kan lage en konfigurasjonsfil som vi kan inkludere på alle sider som kobles til databasen ved å bruke require-setningen. config.php

<?php

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

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

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

$config['password'] = '';

?>

La oss nå se på eksempelkoden som krever konfigurasjonsfilen. Pages_model.php

<?php

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

//other code for connecting to the database

?>

PHP inkluderer vs krever

Forskjellen mellom å inkludere og kreve vises nedenfor.

Generelt anbefales det å bruke include-setningen, slik at når det oppstår en feil, fortsetter kjøringen av skriptet å vise e-postadressen til webansvarlig eller kontaktsiden.

Require-setningen skal brukes hvis hele skriptet ikke kan kjøres uten den forespurte filen.

«Include»- og «require»-setningene kan brukes på hvilken som helst linje i kildekoden der du vil at koden skal vises.

Kommentarer til PHP-dokumentasjonen (PHPDoc)

Utover kommentarer på én og flere linjer, bruker PHP-utviklere PHPDoc-blokkkommentarer til å dokumentere funksjoner og klasser. En PHPDoc-blokk starter med /** og bruker tagger som @param og @return som IDE-er leser for å vise hint og autofullføre.

<?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 endrer ikke hvordan koden kjører, men den tydeliggjør hensikten med hver funksjon og lar verktøy generere API-dokumentasjon automatisk. Ved å legge den til delte filer, som konfigurasjons- og hjelpefilene ovenfor, holder du en voksende kodebase vedlikeholdbar.

Spørsmål og svar