Leesbare code

Leesbare code

Dit onderdeel van de opdracht heeft niet alleen met processing.js of javascript te maken. Leesbare code schrijven is heel belangrijk in alle programmeertalen. Leesbare code is code die aan een aantal regels voldoet. Hiermee bedoelen we niet syntax-regels die we al gezien hebben maar de regels hoe de code eruit komt te zien.

In de voorbeelden die gegeven zijn in de afgelopen hoofdstukken heb je gezien hoe ik de code (bijna) altijd opbouw. Het belangrijkste is dat je de { en } die bij elkaar horen altijd op dezelfde afstand van het kader zet (indent). Zo kan je makkelijk zien welke regels code bij elkaar horen. De code die je daartussen zet is dan weer '1 stap verder' gezet. Hiermee bedoel ik dat de code die bij elkaar gegroepeerd wordt door de accolades '1 tab' of '1 keer 2 spaties' of '1 keer 4 spaties' verder van het kader te zetten. Welke keuze je maakt (een tab, twee spaties,...) voor 'de stap' is niet belangrijk, als je het maar constant doet!! Bij het maken van een stuk code met een functie en een 'if-else' bijvoorbeeld:

function randomName()
{
    var a = 0;
    if(a<0)
    {
        a = a * -1;
    }
    else
    {
        a = a * 10;
    }
}

Zoals je hierboven ziet zijn alle accolades die bij elkaar horen op dezelfde 'diepte' gezet. De code daartussen is weer 1 'stap dieper' gezet. Ik heb ervoor gekozen om het 4 spaties te maken en dat doe ik constant bij elke regel. Wil jij er 2 spaties of een tab voor in de plaats gebruiken mag dat ook, als je dat maar constant doet!
Voor een computer werkt de code hieronder precies hetzelfde:

function randomName(){var a = 0;if(a<0){a = a * -1;}else{a = a * 10;}}

Je merkt al direct dat het voor ons een stuk moeilijker lezen is en het is ook veel lastiger om te zien welke regels nou precies bij elkaar horen.
Naast deze 'regel' voor leesbare code is het ook belangrijk dat je de variabelen een logische naam geeft. Dit hebben we al besproken bij het onderdeel variabelen.

Het schrijven van leesbare code is handig en belangrijk! Niet alleen zodat je zelf later de code makkelijker kan lezen maar ook voor andere personen die je code lezen en misschien moeten gebruiken of aanpassen is het makkelijker.

Naast het feit dat het makkelijker leesbaar is is het ook een onderdeel van de beoordeling dus verlies je punten als je het niet doet!.