Commentaar toevoegen in PHP

Commentaar binnen een programmeertaal zijn bepaalde aantekeningen die kunnen worden gebruikt voor het duidelijk maken van het doel en de bedoeling van een blok code. Bij het gebruiken van PHP heb je meerdere opties om uit te kiezen die afstammen van veel gebruikte, oudere programmeertalen met twee keuzes als het gaat om commentaar op één regel en ook een meerregelige commentaarvorm, afgeleid van de stijl zoals gebruikt in de programmeertaal C. Je kunt commentaar gebruiken om te voorkomen dat blokken code worden uitgevoerd, en je kunt ze zelfs gebruiken om documentatie te genereren.

Deel 1

Deel 1 van 2:

Stijlen

Pdf downloaden

Als je een korte opmerking wilt plaatsen, dan kun je daar de eenregelige code voor gebruiken. Dit commentaar gaat niet verder dan het einde van de regel of het einde van het codeblok. Dit type commentaar werkt alleen binnen PHP-tags en zal worden gelezen indien het binnen HTML-code wordt geplaatst.^[1]XBron
Advertentie

 <?php// Dit is de standaard (C++)  manier voor het creëren van een eenregelig commentaar# Je kunt ook gebruik maken deze Unix-stijl voor eenregelig commentaar?>

Meerregelig commentaar is handig voor het schrijven van een langere uitleg, of om te voorkomen dat een bepaald codesegment wordt uitgevoerd. Lees het deel "Gebruik" hieronder voor wat tips over het toepassen van meerregelig commentaar.^[2]XBron

 <?php /* Op deze manier geef je meerregelig commentaar aan. Alles tot aan de einde-tag zal in het commentaar worden meegenomen*//* Sommige mensen vinden het prettig * om extra markeringen aan te geven aan het begin* van elke regel. Dit kan de leesbaarheid* van langer commentaar verbeteren, maar het is niet noodzakelijk.*/ ?>

Deel 2

Deel 2 van 2:

Gebruik

Pdf downloaden

1
Gebruik commentaar om opmerkingen achter te laten over de werking van de code. Het is niet nodig om dit voor elke regel code te doen, omdat goed geschreven code gemakkelijk te begrijpen is voor andere programmeurs. Het is nuttig als er zich in de code ongewone of onduidelijke functies bevinden.^[3]XBron
```
// Genereer curl-verzoek$session = curl_init($request);// Vertel curl om HTTP POST te gebruikencurl_setopt ($session, CURLOPT_POST, true);
```
1. Laat commentaar achter, zodat je niet vergeet wat je hebt gedaan. Werk je aan je eigen projecten, dan kan commentaar je helpen te herinneren waar je was gebleven. Plaats commentaar bij code die niet goed werkt, of die je nog niet hebt afgerond.
```
// Moet hier nog naar kijken voor ik verder gaecho "Hello World!";
```
1. Plaats commentaar bij code die je wilt gaan delen. Als je van plan bent om samen te werken met anderen, of je wilt de code opensource maken, dan kan commentaar anderen helpen om te achterhalen wat je functies doen en waar ze het best verbeteringen aan kunnen brengen.^[4]XBron
```
/* Is er een effectievere manier om dit te doen? */Geslacht:<input type="radio" name="gender"<?php if (isset($gender) && $gender=="female") echo "checked";?>value="female">Vrouw<input type="radio" name="gender"<?php if (isset($gender) && $gender=="male") echo "checked";?>value="male">Man
```
1. Gebruik commentaar om te voorkomen dat bepaalde blokken code worden uitgevoerd. Dit is handig als je iets wilt testen en wilt voorkomen dat bepaalde code wordt gedraaid. Alles binnen de commentaar-tags zal worden genegeerd tijdens het laden van de webpagina.
```
 <?php echo "/*Hallo*/ Wereld!";  /* Het woord "Hallo" zal niet worden getoond wanneer de bovenstaande code wordt uitgevoerd*/  ?>
```
2
Wees voorzichtig met het becommentariëren van grote blokken code. De comment-functie zal stoppen wanneer de eerste eind-tag wordt gesignaleerd, dus als er al meerregelig commentaar aanwezig is binnen de code die je als commentaar aan wilt merken, dan zal dit commentaar stoppen bij het einde van het geneste commentaar.
```
 <?php  /* echo "Hallo Wereld!"; /* Dit commentaar schopt de boel in de war */*/ ?>
```
```
 <?php  /* echo "Hallo Wereld!"; // Dit commentaar is geen probleem*/ ?>
```

How.com.vn Nederlands: Step 3 Gebruik commentaar voor het creëren van pseudo-documentatie.

Je kunt gebruik maken van wat creatief opmaken voor het aanmaken van documentatie voor je code, direct in de code. Dit kan nuttig zijn bij opensourceprojecten.

 <?php  //============= // HEADING //=============  //------------- // Sub-Heading //-------------  /* Titel van het deel */# Documentatie kan hier geplaatst worden# Een tweede stuk kan hier geplaatst worden  /* * Gebruik dit om iets uit te leggen * waar meerdere regels voor nodig zijn of * zelfs meerdere paragrafen om uit te leggen */  ?>

Advertentie

Tips

HTML-commentaar en PHP-commentaar verschillen van elkaar, dus als je scripting gebruikt (een mix van HTML en PHP), let er dan op dat je de codes voor het aangeven van commentaar niet door elkaar haalt.
In de onderstaande code bijvoorbeeld, staat HTML-commentaar, maar wordt nog steeds PHP-code uitgevoerd. Het plaatsen van HTML-commentaar binnen PHP-tags zal fouten veroorzaken.
-

Advertentie