PHP-kommentarer, Inkludera/Inkludera_en gång, Require/Require_once

Varför använda kommentarer?

• Om du inte arbetar med källkoden på ett tag är det lätt att glömma vad koden gör. Att kommentera källkoden hjälper dig att komma ihåg vad koden gör.
• Att kommentera källkod är också mycket viktigt när flera utvecklare måste arbeta med samma projekt. Ändringarna som gjorts av en utvecklare kan lätt förstås av andra utvecklare genom att helt enkelt läsa kommentarerna.
• Som en god praxis bör du ha 3 rader kommentarer för varje 10 rader kod.

PHP-kommentarer

• Kommentarer hjälper oss att förstå koden
• Kommentarer är förklaringar som vi inkluderar i vår källkod. Dessa kommentarer är till för mänsklig förståelse.
• Kommentarer på en rad börjar med dubbla snedstreck // och slutar på samma rad.
• 
• Kommentarer på flera rader börjar med ett snedstreck följt av asterisken /* och slutar med asterisken följt av snedstrecket */.
• 

Diagrammet nedan visar en PHP-fil med kommentarer på både flera rader och en rad.

PHP exempel

PHP Include & PHP Include_once

PHP-satsen "include" används för att inkludera andra filer i en PHP-fil.

Den har två varianter, include och include_once. include_once ignoreras av PHP-tolken om filen som ska inkluderas redan har inkluderats.

Inkludera-satsen har följande syntax

<?php
include 'file_name';
?>

Satsen include_once har följande syntax

<?php
include_once 'file_name';
?>

HÄR,

• ”include/include_once” är den sats som inkluderar filen
• ”'filnamn'” är namnet på den fil som ska inkluderas.

Exempel: Inkludera / Inkludera_en gång

Anta att du är utveckladping en webbplats som innehåller samma navigeringsmeny på alla sidor.

Du kan skapa en gemensam rubrik och sedan inkludera den på varje sida med hjälp av include-satsen. Låt oss se hur detta kan göras.

• Vi kommer att skapa två filer med namnet
• header.php, index.php

Nedan finns koden för 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';

?>

Rubriksidan ovan visar navigeringslänkarna.

PHP Require & PHP require_once

Require-satsen har två varianter, require och require_once.

Satsen require/require_once används för att inkludera en fil.

require_once ignoreras om den obligatoriska filen redan har lagts till av någon av de fyra include-satserna.

Den har följande syntax

<?php
require 'file_name';
?>

<?php
require_once 'file_name';
?>

HÄR,

• ”require/require_once” är den sats som inkluderar filen
• ”'filnamn'” är namnet på den fil som ska inkluderas.

Exempel: Kräv

Anta att vi utvecklarping en databasdriven applikation.

Vi kan skapa en konfigurationsfil som vi kan inkludera på alla sidor som ansluter till databasen med hjälp av require-satsen. config.php

<?php

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

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

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

$config['password'] = '';

?>

Låt oss nu titta på exempelkoden som kräver konfigurationsfilen. Pages_model.php

<?php

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

//other code for connecting to the database

?>

PHP inkluderar vs kräver

Skillnaden mellan att inkludera och kräva visas nedan.

Generellt sett rekommenderas det att använda include-satsen så att när ett fel uppstår fortsätter skriptet att visa webbansvarigs e-postadress eller kontaktsidan.

Require-satsen ska användas om hela skriptet inte kan köras utan den begärda filen.

"Include"- och "require"-satserna kan användas på vilken rad som helst i källkoden där du vill att koden ska visas.

Kommentarer till PHP-dokumentationen (PHPDoc)

Utöver kommentarer med en eller flera rader använder PHP-utvecklare PHPDoc-blockkommentarer för att dokumentera funktioner och klasser. Ett PHPDoc-block börjar med /** och använder taggar som @param och @return som IDE:er läser för att visa tips och autokomplettera.

<?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 ändrar inte hur koden körs, men det gör syftet med varje funktion tydligt och låter verktyg generera API-dokumentation automatiskt. Genom att lägga till den i delade filer, som konfigurations- och hjälpfilerna ovan, håller man en växande kodbas underhållbar.

Vanliga frågor