Leesbaarheid

Het is belangrijk dat je tijdens het programmeren overzichtelijk programmeert. Denk hierbij bijvoorbeeld aan de volgende dingen:

  • Variabelen buiten quotes en de juiste quotes gebruiken
  • Aanduiding van het type
  • Commentaar
  • Inspringen
  • Voldoende ruimte
  • Duidelijke query's (hier komen we later op terug)
  • Het gebruik van de juiste editor

Dit is natuurlijk erg leuk om te weten, maar hoe doe je dat nou, zo netjes en overzichtelijk programmeren? Dat leg ik uit aan de hand van het volgende voorbeeld, waarbij we een array hebben waar we doorheen lopen en de voornamen en achternamen van enkele mensen op het scherm tonen.

Code (php)
PHP script in nieuw venster Selecteer het PHP script
1
2
3
4
5
6
<?php
$namen = array("Stan"=>"Marsh","Kyle"=>"Broflovski","Eric"=>"Cartman","Kenny"=>"McCormick");
foreach($namen as $voornaam=>$achternaam){
echo "Naam: $voornaam $achternaam<br/>";
}
?>


Je ziet dat er in het bovenstaande voorbeeld geen enkele duidelijkheid zit, en dit maakt het alleen maar moeilijker om het later terug te lezen. Laten we eens kijken naar een duidelijke code.

Code (php)
PHP script in nieuw venster Selecteer het PHP script
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<?php
// Array met de mensen waarbij de key de voornaam is en de value de achternaam
$aNamen = array(
    'Stan' => 'Marsh',
    'Kyle' => 'Broflovski',
    'Eric' => 'Cartman',
    'Kenny' => 'McCormick'
);

// Doorloop de array en toon de mensen en plaats ze ieder op een nieuwe regel
foreach ($aNamen as $sVoornaam => $sAchternaam)
{
    echo 'Naam: ' . $sVoornaam . ' ' . $sAchternaam . '<br />';
}
?>


Variabelen buiten quotes en juiste quotes gebruiken
In het eerste voorbeeld zie je dubbele quotes (") om iets op het scherm te tonen. Voor de overzichtelijkheid en het gemak, gebruiken we enkele quotes ('). Dit doe je omdat je zo voor HTML niet hoeft te escapen, maar vooral omdat het overzichtelijker is.

Aanduiding van het type
Je ziet dat dit er een stuk duidelijker uitziet. De naam array begint nu met een a om het type array aan te duiden, gevolgd door de naam van de array (namen). Door de eerste letter van het type voor de naam te zetten, schep je duidelijkheid in je variabelen. Je kunt dan tijdens het debuggen in één keer zien wat voor type je variabele is, wat veel tijd kan besparen.

Nog enkele voorbeelden
Array$aNamen
String$sWoord
Integer$iGetal
Boolean$bGelukt

Commentaar
Ook zie je commentaar boven stukjes code staan. Dit geeft (in het kort) aan wat dat stukje code doet. Wanneer iemand anders jouw werk overneemt en je hebt geen commentaar bij je code staan, dan kan het lastig worden voor de programmeur om verder te bouwen aan jouw webapplicatie.

Inspringen
Om 'unexpected $end' errors makkelijker op te sporen en om je code overzichtelijker te maken, is het van belang dat je bij een scope ({ en }) inspringt. Dat wil zeggen dat je de body van een scope een stukje naar rechts zet, zodat iedere if, while, etc. netjes uit te lezen is. Als je bijvoorbeeld een 'unexpected $end' error krijgt, kijk je gewoon waar je een } mist, en los je het probleem zo op.

Voldoende ruimte
Zorg dat je voldoende ruimte tussen verschillende stukjes code hebt. Zo is het bijvoorbeeld overzichtelijker om bij een if-statement niet gelijk ()-haken te typen, maar om eerst een spatie te typen. Dit geldt overigens ook voor een echo (ruimte tussen aan elkaar geplakte stukken met punten).

Vergelijk het eerste voorbeeld maar eens goed met het tweede, zo zul je zien dat het tweede voorbeeld veel makkelijker te lezen en te begrijpen is dan het eerste voorbeeld.

Het is natuurlijk niet verplicht deze manier van programmeren aan te houden. Mocht je bijvoorbeeld accolades ({ en }) liever op dezelfde regel zetten als een if-statement, dan is dat geen enkel probleem!

Het gebruik van de juiste editor
Het gebruik van de juiste editor is ook erg belangrijk. Met name de syntax highlighting is erg belangrijk, want op die manier kun je vrijwel nooit fouten krijgen als je bijvoorbeeld bent vergeten een echo af te sluiten met een quote. Ook het automatisch aanvullen van functienamen is een groot voordeel. Hieronder een greep uit een aantal goede editors, zowel gratis als betaald:
Notepad2GratisDownload
Notepad++GratisDownload
AptanaGratisDownload
NetBeansGratisDownload
VimGratisDownload
EclipseGratisDownload
phpDesignerGratisDownload
TextPadGratisDownload
Sublime Text 2ProefversieDownload
Zend StudioBetaaldDownload

Referenties

volgende pagina »

« Lees de omschrijving en reacties

Inhoudsopgave

  1. Leesbaarheid
  2. SQL-injection
  3. XSS-injection
  4. Gebruik van backticks in MySQL
  5. Correcte foutenafhandeling
  6. Geheugenefficiënt programmeren
  7. Slot

PHP tutorial opties

 
 

Om de gebruiksvriendelijkheid van onze website en diensten te optimaliseren maken wij gebruik van cookies. Deze cookies gebruiken wij voor functionaliteiten, analytische gegevens en marketing doeleinden. U vindt meer informatie in onze privacy statement.