Commentaar
Commentaar is zeer belangrijk bij een programma. Zeg wat er zou moeten gebeuren of wat het programma doet. Niks is zo erg als debuggen zonder commentaar erbij. Niks is zo erg als eerst een programma maken, en daarna de commentaar erbij moet prutsen. Commentaar is een van de dingen die je programma overzichtelijk maakt.
Dit geldt niet alleen voor PHP, maar ook voor andere talen dat je altijd commentaar moet gebruiken.
Commentaar is ook belangrijk als je een probleem heb en je komt er zelf niet uit, misschien komen ze op het forum er wel uit als je commentaar erbij heb gezet??
Of als je een script post is commentaar wel zo fijn voor de lezer.
Kijk eens naar het onderstaande stuk, zie jij heel snel wat het doet?
Code (php)
Niet echt hè? En nu?
Code (php)
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
<?php
//Include het bestand met mysql connectie variablen en functies
require "settings.php";
//maak een database connectie met mijn zelfgemaakte functie
connect();
//maak een variable aan(niet echt nodig, maar het staat mooi)
$array = array();
// gebruik zelfgemaakte functie get_array_elements() om
// data uit de database en de tabel 'html' te verkrijgen
$array = get_array_elements();
// En nu, echo de header!
echo $array['header'];
?>
//Include het bestand met mysql connectie variablen en functies
require "settings.php";
//maak een database connectie met mijn zelfgemaakte functie
connect();
//maak een variable aan(niet echt nodig, maar het staat mooi)
$array = array();
// gebruik zelfgemaakte functie get_array_elements() om
// data uit de database en de tabel 'html' te verkrijgen
$array = get_array_elements();
// En nu, echo de header!
echo $array['header'];
?>
Hier zie je al een stuk sneller wat het doet hè?
Overbodig commentaar
Commentaar is goed, heel goed. Maar als er teveel van is, wordt een programma weer onoverzichtelijk. Laten we het bovenstaande programma erweer bij pakken en overbodig commentaar erbij gooien.
Code (php)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
<?php
//Include het bestand met de site settings, settings voor de chatbox,
//settings voor het pad van de site, de url van de site, en mysql connectie vars
// en natuurlijk niet te vergeten allemaal zelfgemaakte functie (duhhh)
require "settings.php";
//maak een database connectie met mijn zelfgemaakte functie connect()
//hij connecteert standaard naar tabel 'site' in mysql
// en dat wil ik nu, want we hoeven nu ff niet naar postgresql te
//connecteren, dus we hoeven ook geen parameters op te geven!
connect();
//maak een variable aan(niet echt nodig, maar het staat mooi)
//misschien geeft hij een notice dus dat wil ik voorkomen,
// want dat staat zo raar.
$array = array();
// gebruik zelfgemaakte functie get_array_elements() om
// data uit de database en de tabel 'html' te verkrijgen
// dan kan ik die data met foreach($array as $key => $value)
// er weer uithalen, ik kan natuurlijk ook alleen echo $array['header']
// doen, dan output ie de header, maar niet alle data,
// want dat is best onhandig en me script wordt er langzaam van
$array = get_array_elements();
// En nu, echo de header!
// dan krijgen we database data die ik in me eigen zelfgemaakte
// admin cp samen met html outgeput
// <title>$obj->titel</title> staat er in de code dus dat
// bewijst dat we mysql gebruiken
echo $array['header'];
//nu is dit script klaar.
// dit includen we in index.php met
// include('$header.php');
// en dan hebben we een header!!
?>
//Include het bestand met de site settings, settings voor de chatbox,
//settings voor het pad van de site, de url van de site, en mysql connectie vars
// en natuurlijk niet te vergeten allemaal zelfgemaakte functie (duhhh)
require "settings.php";
//maak een database connectie met mijn zelfgemaakte functie connect()
//hij connecteert standaard naar tabel 'site' in mysql
// en dat wil ik nu, want we hoeven nu ff niet naar postgresql te
//connecteren, dus we hoeven ook geen parameters op te geven!
connect();
//maak een variable aan(niet echt nodig, maar het staat mooi)
//misschien geeft hij een notice dus dat wil ik voorkomen,
// want dat staat zo raar.
$array = array();
// gebruik zelfgemaakte functie get_array_elements() om
// data uit de database en de tabel 'html' te verkrijgen
// dan kan ik die data met foreach($array as $key => $value)
// er weer uithalen, ik kan natuurlijk ook alleen echo $array['header']
// doen, dan output ie de header, maar niet alle data,
// want dat is best onhandig en me script wordt er langzaam van
$array = get_array_elements();
// En nu, echo de header!
// dan krijgen we database data die ik in me eigen zelfgemaakte
// admin cp samen met html outgeput
// <title>$obj->titel</title> staat er in de code dus dat
// bewijst dat we mysql gebruiken
echo $array['header'];
//nu is dit script klaar.
// dit includen we in index.php met
// include('$header.php');
// en dan hebben we een header!!
?>
Dit is overbodig commentaar, toegegeven, je moet wel een een of andere hansworst zijn om zo commentaar te schrijven, maar toch gebeurt het. Vergis je niet!
« vorige pagina | volgende pagina »