Pytanie 1
Wskaż sposób oznaczania komentarzy wielowierszowych w kodzie PHP.
Można to wykorzystać np. tak:
/*
Funkcja liczy sumę dwóch liczb
Parametry:
$a – pierwsza liczba
$b – druga liczba
*/
function suma($a, $b) {
return $a + $b;
}
Z mojego doświadczenia dobrze jest używać komentarzy wielowierszowych do opisywania całych bloków logiki, np. większych funkcji, klas albo skomplikowanych fragmentów algorytmu. W dokumentacji i w dobrych projektach często spotyka się też komentarze stylizowane na PHPDoc, np.:
/**
* Zwraca sumę dwóch liczb całkowitych
* @param int $a
* @param int $b
* @return int
*/
To nadal jest zwykły komentarz wielowierszowy, tylko używany zgodnie z pewnym standardem narzędziowym. Moim zdaniem warto wyrabiać sobie nawyk pisania czytelnych komentarzy, ale jednocześnie nie przesadzać – komentarz wielowierszowy powinien wyjaśniać „dlaczego” coś jest zrobione w określony sposób, a nie przepisywać oczywistości z kodu. W praktyce w PHP używa się trzech form komentarzy: // dla jednowierszowych, # (rzadziej, ale też działa) oraz właśnie /* */ dla wielowierszowych. Znajomość tej składni to absolutna podstawa przy pracy z większymi projektami PHP, bo bez niej kod szybko staje się nieczytelny dla innych programistów.


