commentaar // #
Ik gebruik voor 1 regel commentaar altijd //
Nu kwam ik erachter dat # ook werkt, maar dit heb ik nooit eerder gezien. Is dat een normale manier die ik gewoon kan gebruiken of is dat verouderd?
/*
//
#
Allemaal geldig :)
Lekker makkelijk als je je commentaar wilt uitbreiden naar meerdere regels.
Voorbeeld:
Code (php)
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
/**
* @param int $id
* @param int $aantal
* @param bool $keuze
* @return bool
*/
function functie($id, $aantal, $keuze){
return true;
}
* @param int $id
* @param int $aantal
* @param bool $keuze
* @return bool
*/
function functie($id, $aantal, $keuze){
return true;
}
voorbeeld:
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
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
<?php
# Stap 1: maak het formulier
echo ' hier het formulier ';
# stap 2: gooi de gegevens in de database
if($_SERVER['REQUEST_METHOD'] == 'POST')
{
# check gegevens
if(strlen($_POST['veld']) < 3)
{
echo 'veld moet minstens 3 tekens bevatten.' // geef de foutmelding
}
else
{
# maak de query
$sql = "query"; // let op sql-injectie!
# voer query uit
# check query
}
}
?>
# Stap 1: maak het formulier
echo ' hier het formulier ';
# stap 2: gooi de gegevens in de database
if($_SERVER['REQUEST_METHOD'] == 'POST')
{
# check gegevens
if(strlen($_POST['veld']) < 3)
{
echo 'veld moet minstens 3 tekens bevatten.' // geef de foutmelding
}
else
{
# maak de query
$sql = "query"; // let op sql-injectie!
# voer query uit
# check query
}
}
?>
zo doe ik het, is dat een beetje duidelijk?
Wat is de meerwaarde eigenlijk Jasper (no offence, ik vraag het mij gewoon af)?
@eric, het is gewoon eigen smaak. Je moet doen van je zelf het netst vindt. Ik wou mijn manier gewoon even delen. ;)
Roel, niet commentariseren is niet handig en niet slim. Nu weet je nog hoe je code in elkaar zit maar over een half jaar niet meer. Je eigen commentaar helpt je dan om snel te doorzien hoe de code in elkaar zit.
Jasper, je commentaar kan wat korter, dus niet voor iedere regel ook een regel commentaar. In plaats daarvan geef je commentaar per codeblok. Dus niet: haal databaseverbinding op, maak query, haal gegevens uit de database, stop gegevens in de variabele $data, maar... in plaats daarvan: haal gegevens uit de database en stop ze in $data. Dit is zomaar een voorbeeldje, maar hopelijk begrijp je wat ik bedoel. Probeer dus niet regel voor regel te beschrijven, maar probeer het per codeblok te beschrijven.
Het wordt wel een ander verhaal als een ander ermee aan de slag moet.
Zolang dat niet hoeft, doe ik het zo :)
@Jasper: oké dan ;-)