PHP-kommentarer, Inkluder/Inkluder_en gang, Require/Require_once

Hvorfor bruge kommentarer?

• Hvis du ikke arbejder på kildekoden i et stykke tid, er det nemt at glemme, hvad koden gør. At kommentere kildekoden hjælper dig med at huske, hvad koden gør.
• Det er også meget vigtigt at kommentere kildekoden, når flere udviklere skal arbejde på det samme projekt. Ændringerne foretaget af en udvikler kan let forstås af andre udviklere ved blot at læse kommentarerne.
• Som en god praksis bør du have 3 linjer med kommentarer for hver 10 linjer kode.

PHP kommentarer

• Kommentarer hjælper os med at forstå koden
• Kommentarer er forklaringer, som vi inkluderer i vores kildekode. Disse kommentarer er til menneskelig forståelse.
• Kommentarer på én linje starter med dobbelte skråstreger // og slutter på samme linje.
• 
• Kommentarer på flere linjer starter med en skråstreg efterfulgt af stjernen /* og slutter med stjernen efterfulgt af skråstregen */.
• 

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

PHP eksempel

PHP Include & PHP Include_once

PHP-sætningen "include" bruges til at inkludere andre filer i en PHP-fil.

Den har to variationer, include og include_once. include_once ignoreres af PHP-fortolkeren, hvis den fil, der skal inkluderes, allerede er inkluderet.

Inkluder-sætningen har følgende syntaks

<?php
include 'file_name';
?>

include_once-sætningen har følgende syntaks

<?php
include_once 'file_name';
?>

HER,

• "include/include_once" er den sætning, der inkluderer filen
• “'filnavn'” er navnet på den fil, der skal inkluderes.

Eksempel: Inkluder / Inkluder_én gang

Antag, at du er udvikletping en hjemmeside, der indeholder den samme navigationsmenu på tværs af alle sider.

Du kan oprette en fælles header og derefter inkludere den på hver side ved hjælp af include-sætningen. Lad os se, hvordan dette kan gøres.

• Vi opretter 2 filer med navnet
• header.php, index.php

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

?>

Overskriften ovenfor viser navigationslinkene.

PHP Require & PHP require_once

Require-sætningen har to variationer, require og require_once.

`require/require_once`-sætningen bruges til at inkludere en fil.

require_once ignoreres, hvis den nødvendige fil allerede er tilføjet af en af ​​de fire include-sætninger.

Den har følgende syntaks

<?php
require 'file_name';
?>

<?php
require_once 'file_name';
?>

HER,

• "require/require_once" er den sætning, der inkluderer filen
• “'filnavn'” er navnet på den fil, der skal inkluderes.

Eksempel: Kræv

Antag, at vi er udvikledeping en databasedrevet applikation.

Vi kan oprette en konfigurationsfil, som vi kan inkludere på alle sider, der forbinder til databasen ved hjælp af require-sætningen. config.php

<?php

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

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

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

$config['password'] = '';

?>

Lad os nu se på eksempelkoden, der kræver konfigurationsfilen. Pages_model.php

<?php

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

//other code for connecting to the database

?>

PHP inkluderer vs kræver

Forskellen mellem include og require er vist nedenfor.

Generelt anbefales det at bruge include-sætningen, så scriptet fortsat viser webmasterens e-mailadresse eller kontaktsiden, når der opstår en fejl.

Require-sætningen skal bruges, hvis hele scriptet ikke kan køre uden den anmodede fil.

Udsagnene "include" og "require" kan bruges på enhver linje i kildekoden, hvor du ønsker, at koden skal vises.

Kommentarer til PHP-dokumentation (PHPDoc)

Ud over kommentarer med én eller flere linjer bruger PHP-udviklere PHPDoc-blokkommentarer til at dokumentere funktioner og klasser. En PHPDoc-blok starter med /** og bruger tags som @param og @return, som IDE'er læser for at vise hints og autofuldførelse.

<?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 ændrer ikke, hvordan koden kører, men det tydeliggør intentionen med hver funktion og lader værktøjer generere API-dokumentation automatisk. Ved at tilføje det til delte filer, såsom ovenstående konfigurations- og hjælpefiler, holder du en voksende kodebase vedligeholdelig.

Ofte Stillede Spørgsmål