Commentaar

ICTscripters maakt gebruik van cookies. Door het gebruiken en browsen naar onze site gaat je automatisch akkoord met het gebruik van cookies. Klik hier voor meer informatie

  • Commentaar is handig als andere mensen in je scripts kijken en natuurlijk ook als jij over 5 jaar nog iets van je code wil snappen. Je wil geen code van honderden regels doorkijken, maar dit netjes zien in een overzicht. Ik heb deze tutorial gemaakt voor degene die efficiënt willen omgaan met commentaar. In de tutorial ga ik het hebben over de volgende punten.

    - Wat is commentaar?
    - Verschillende manieren
    - SQL - php - html in een makkelijk overzicht
    - Vervanging voor commentaar
    - Slot



    Wat is commentaar?
    Commentaar is een korte beschrijving van een stuk code in een niet-scripttaal. Daardoor kan je, als je het goed doet, in één oogopslag zien wat een stuk code doet.

    Commentaar is handig als je later iets terug wilt kijken en als je in een teamverband werkt.




    Verschillende manieren
    Ik ga in deze tutorial 3 verschillende manieren behandelen om commentaar in je script te zetten. Hashtag (#), double slash (//), multi-line (/* */). Ook ga ik even in op commentaar in html schrijven.

    Hashtag
    De hashtag komt uit een andere programmeertaal, namelijk perl. Alles wat na de hashtag komt is commentaar en whitespaces worden hierbij genegeerd. Hieronder volgt een voorbeeld van het gebruik.

    PHP Source Code

    1. <?php
    2. #Een variabele met de inhoud 'commentaar'
    3. $tutorial = 'commentaar';
    4. ?>



    Double slash
    De double slash doet exact hetzelfde als de hashtag en komt uit de programmeertaal C++. Alles wat voor de slashes komt is nog gewoon code. Op die manier kan je ook achter je code commentaar geven. Ook gebruikt javascript double slash ook als commentaar. Hieronder weer een voorbeeld.

    PHP Source Code

    1. <?php
    2. //Een variabele met de inhoud 'commentaar'
    3. $tutorial = 'commentaar'; //Commentaar achter de variabele
    4. ?>



    Multi-line
    Multi-line komt van de programmeertaal CSS. De naam zegt het al een beetje. De multi-line zorgt ervoor dat je op meerdere regels commentaar kunt zetten. Ook hier worden whitespaces genegeerd en alles tussen /* en */ is commentaar. Hieronder volgt een voorbeeld.

    PHP Source Code

    1. <?php
    2. /*
    3. Een variabele met de inhoud
    4. 'commentaar'
    5. */
    6. $tutorial = 'commentaar';
    7. ?>



    Html
    Als laatste wil ik het ook nog hebben over commentaar in html. Hiervoor gebruik je pijlen (<!-- -->). Whitespaces worden ook hier genegeerd en alles tussen de pijlen is commentaar. Dit is net zoals multi-line over meerdere regels code. Hieronder volgt een voorbeeld.

    HTML Source Code

    1. <html>
    2. <head>
    3. <title></title>
    4. </head>
    5. <body>
    6. <!-- Regels commentaar
    7. Regels commentaar
    8. -->
    9. </body>
    10. </html>
    Laat alles zien


    Hierbij kan je ook nog code maken allen voor IE door het volgende te doen.

    Source Code

    1. <!--[if IE]>
    2. <![endif]-->



    SQL - php - html in een makkelijk overzicht
    Iets wat misschien niet iedereen kent, maar ontzettend handig is. Een overzicht waarin je de benamingen van een item in een tabel hebt staan. Hierdoor kan je makkelijk zien hoe je alles hebt genoemd. Deze tabel methode maakt gebruikt van multi-line commentaar. Hieronder staat een voorbeeld.

    PHP Source Code

    1. <?php
    2. /**
    3. * Voorbeeld van een tabel voor een inlogformulier
    4. *
    5. * +------------------------+------------------+--------------------------+
    6. * | Formulier in HTML | Variabele in PHP | Tabel en kolom in MySQL |
    7. * +------------------------+------------------+--------------------------+
    8. * | name="gebruikersnaam" | $gebruikersnaam | gebruikers.gebruikersnaam|
    9. * | name="wachtwoord" | $wachtwoord | gebruikers.wachtwoord |
    10. * +------------------------+------------------+--------------------------+
    11. */
    12. ?>
    Laat alles zien



    Vervanging voor commentaar
    Iets dat misschien nog wel waardevoller is dan commentaar is het niet gebruiken van commentaar. Nu denk je waarschijnlijk 'huh? Het is toch juist wel handig?'. Dat klopt, maar een goede programmeur kan ervoor zorgen dat iets duidelijk is zonder commentaar.

    Om duidelijk te maken geef ik een voorbeeld waarin duidelijk te zien is dat je het commentaar eigenlijk beter kan weghalen.

    PHP Source Code

    1. <?php
    2. //Echo'd het woord 'commentaar'
    3. echo 'commentaar';
    4. ?>


    Nu heb je in het beschrijven jezelf eigenlijk herhaald. Daarnaast is het noodzakelijk dat je zinvolle variabele namen gebruikt. Je weet over een aantal jaar niet meer wat $user1, $user2, $user3 is. Als je bijvoorbeeld $gebruikersnaam, $wachtwoord en $naam gebruikt is dat veel duidelijker.

    Als laatste wil ik nog ingaan op een duidelijke manier van een functie beschrijven. Hierin is in één oogopslag te zien wat het doet en wat de functie returned. Het voorbeeld zegt eigenlijk al genoeg.

    PHP Source Code

    1. <?php
    2. /**
    3. * @param String $user
    4. * @access Public
    5. * @return Gebruiker
    6. */
    7. public function getId($user)
    8. {
    9. return $gebruiker;
    10. }
    11. ?>
    Laat alles zien




    Slot
    Ik heb deze tutorial geschreven, omdat ik het belangrijk vind dat iedereen net, veilig en overzichtelijk script. Deze tutorial gaat dan in op het overzichtelijk maken van je script.

    Mochten jullie nog vragen hebben dan hoor ik die graag!
    Met vriendelijke groet,

    Victor
    Beheerder ICTscripters

    1,171x gelezen

Reacties 4

  • Ferhat.Remory -

    Interessant voor sommige leden, super!

  • victor -

    Bedankt voor jullie reacties!

    Ik ga meteen je opmerkingen verwerken. Ik was vergeten om te vertellen waar multi-line vandaan kwam. Zal de rest er even bij zetten. ;)

  • M.Martens -

    Zinnig onderweg.

  • bramieboy100 -

    Ik heb een paar opmerkingen:
    Niet zo belangrijk maar /*deze twee*/ komen van C (CSS gebruikt deze ook, misschien ook handig om te melden), // gebruikt JavaScript. Misschien ook handig om te melden dat alles na de // of # commentaar is maar daarvoor je wel werkende PHP code kan plaatsen zodat je voor een stukje code commentaar kan leveren.

    Edit: Bij de HTML commentaar is het ook handig om te melden wat je ermee kunt. Je kunt er bijv. speciale code voor IE invoegen.