Hoe opmerkingen toevoegen aan uw PHP-programma


Elke programmeur heeft zijn mening over welke informatie moet worden opgenomen in de programmacode. De meeste programmeurs voegen opmerkingen toe met hun code om zichzelf en anderen eraan te herinneren wat de code doet en hoe het werkt. Als u besluit welke informatie u wilt opnemen, vraag uzelf dan wat u over het programma moet worden verteld als iemand anders het programma heeft geschreven en u nu wordt gevraagd het uit te voeren en te onderhouden.

De meeste programma's die u schrijft, hebben meer dan één pagina met code. Elke pagina met code wordt opgeslagen als een PHP-programmabestand. (bestandsnaam.php3) Er zijn twee plaatsen in het programmabestand waar u informatief commentaar wilt toevoegen.

  1. Bovenaan elk programmabestand zult u algemene informatie over het programma opnemen.

    • Helemaal bovenaan het bestand en net na de PHP-tag die u opent, plaatst u de naam van het bestand zoals HelloWorld.php3.
    • Vervolgens voegt u een copyrightkennisgeving toe waarin u wordt vermeld als de auteursrechteigenaar van het programma.
    • Als uw programma meer dan één pagina met code zal hebben, zult u vermelden dat dit één pagina van een groter programma is en de naam van dat programma geven.
    • U wilt ook een korte beschrijving van het doel van het programma en hoe het werkt.
    • Als laatste voegt u eventuele disclaimer- en licentiegegevens toe. Dit kan bijvoorbeeld een licentie zijn die is geschreven door uw advocaat of de GNU General Public License die u vrij kunt gebruiken in al uw freeware-programma's. U kunt een kopie van deze licentie downloaden van de website van Free Software Foundation. We zullen dit meer gedetailleerd bespreken in een aparte tutorial.

  2. Het tweede gebied waar u opmerkingen wilt toevoegen, bevindt zich overal in de code zelf, aan het begin van elk hoofdgedeelte van de code. Voeg een korte opmerking toe over welke taak die bepaalde sectie zal uitvoeren.
Er zijn drie manieren om opmerkingen aan uw programmacode toe te voegen.

// reacties gaan hier
Dit is de standaard PHP-stijlcommentaar. Alles op dezelfde regel en dat komt na de twee // wordt door de server genegeerd en niet als programmacode verwerkt.

# reacties komen hier
Dit is het commentaar in shell-stijl. Alles op dezelfde regel en dat na de # komt, wordt door de server genegeerd en niet als programmacode verwerkt.

/*
opmerkingen komen hier
opmerkingen komen hier
opmerkingen komen hier
*/
Dit is de opmerking in C-stijl. Alles dat zich tussen het openen / * en het sluiten * / bevindt, wordt door de server genegeerd en niet als programmacode verwerkt. U kunt deze stijl gebruiken wanneer u meer dan één regel opmerkingen hebt, zoals we in deze zelfstudie hebben besproken. Klik hier voor een voorbeeld.




Werkbalk Snelle toegang (December 2020)



Labels Artikel: Reacties toevoegen aan uw PHP-programma, PHP, PHP, dynamische webpagina's, webscripttalen, php, relationele databases, MySQL, PHP versie 4, php-programmering, php-tutorials, php-artikelen, php-bronnen, Apache, broncode, webontwikkeling , Webmasters, referentie, tips, applicaties, php basics, php tags, variabelen, operators