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, tymczasowego wyłączania fragmentów kodu oraz ułatwiania pracy innym programistom.

Komentarz jednoliniowy

W PHP komentarz jednoliniowy można rozpocząć znakami // albo #. Wszystko od tego znaku do końca linii nie zostanie wykonane.

<?php
// To jest komentarz jednoliniowy
echo "Witaj"; // komentarz po instrukcji

# To również komentarz jednoliniowy
?>

W pytaniach egzaminacyjnych znak // w PHP najczęściej oznacza właśnie początek komentarza jednoliniowego.

Komentarz wieloliniowy

Komentarz obejmujący wiele linii zapisuje się między /* oraz */.

<?php
/*
  To jest komentarz
  wieloliniowy.
*/
echo "PHP";
?>

Do czego używa się komentarzy?

  • wyjaśnianie trudniejszych fragmentów kodu,
  • opisywanie zmiennych, funkcji i algorytmów,
  • tymczasowe wyłączanie instrukcji podczas testowania,
  • dodawanie informacji dla innych programistów.

Ważne zasady

Komentarze nie powinny zastępować czytelnego kodu. Najlepiej pisać kod tak, aby był zrozumiały, a komentarzy używać tam, gdzie wyjaśniają cel lub nietypowe rozwiązanie.

Nie należy też umieszczać w komentarzach haseł, danych dostępowych ani poufnych informacji, ponieważ kod źródłowy może trafić do repozytorium lub na serwer.