Jeg er klar over, at det i princippet er helt op til mig selv, men det kunne være rart at have nogle overordnede retningslinjer at gå efter "som man nu gør det" :-)
Jeg modtager gerne både eksempler og henvisninger.
Generelt så undgå at spilde tid på at skrive åbenlyse kommentarer.
Foelgende er jo talt taabeligt:
// iterer fra 0 til 9 for($i = 0; $i <= 9; $i++) { // test om $a[$i] er 0 if($a[$i] == 0) { // tael $n op $n++; } }
bidrager ikke med noget som helst.
// tael antal ansatte uden erfaring, fordi der skal allokeres penge til kurser for dem for($i = 0; $i <= 9; $i++) { if($a[$i] == 0) { $n++; } }
fortaeller noget om hvad koden goer.
Generelt er det mest vigtigt med store kommentar blokke i toppen af filen og lige ovenfor en klasse/funktion som forklarer hvad de overordnet goer fremfor forklaringer til enkelte linier. Hvis man ved hvad koden goer er linien nok selv forklarende.
Endnu et eksempel:
var $maengde_vand; // maengden af vand
suk
var $maengde_vand; // maengden af vand maalt i milliliter
nu var der lidt ekstra information - hvem pokker havde gaettet at det var milliliter uden at kunne lase det
Tilladte BB-code-tags: [b]fed[/b] [i]kursiv[/i] [u]understreget[/u] Web- og emailadresser omdannes automatisk til links. Der sættes "nofollow" på alle links.
