Komentarze w PHP
Słownik kwalifikacji INF.03 - Tworzenie i administrowanie stronami i aplikacjami internetowymi oraz bazami danych
Komentarze w PHP to fragmenty kodu ignorowane przez interpreter. Służą do opisywania działania programu, oznaczania ważnych miejsc w kodzie lub tymczasowego wyłączania instrukcji podczas testowania.
Komentarz jednoliniowy
W PHP komentarz obejmujący jedną linię można zapisać na dwa sposoby:
// To jest komentarz jednoliniowy
# To także jest komentarz jednoliniowy
Komentarz działa od miejsca jego rozpoczęcia do końca bieżącej linii.
$wiek = 18; // przypisanie wartości do zmiennej
Komentarz wieloliniowy
Komentarz rozciągający się na wiele linii zapisuje się między znakami /* oraz */:
/*
To jest komentarz
zajmujący kilka linii.
Interpreter PHP go pominie.
*/
Taki zapis jest poprawną odpowiedzią na pytanie o komentarz wieloliniowy w PHP.
Czego nie używać jako komentarza PHP?
Zapis:
<!-- komentarz -->
jest komentarzem w HTML, a nie typowym komentarzem języka PHP. Może pojawić się w pliku PHP jako część kodu HTML, ale nie służy do komentowania instrukcji PHP.
Dobre praktyki
- komentarze powinny wyjaśniać cel kodu, a nie przepisywać oczywiste instrukcje,
- warto komentować trudniejsze fragmenty algorytmu,
- nie należy zostawiać nieaktualnych komentarzy,
- komentarze wieloliniowe są przydatne przy dłuższych opisach lub dokumentacji fragmentu kodu.