Komentowanie kodu w PHP

Data aktualizacji: 22.04.2024r. Autor: Bartosz Stefanicki.

Komentowanie kodu w PHP

Komentarz w PHP nie jest uznawany przez interpreter jako część aplikacji, więc zostaje pominięty podczas odczytywania. Dlaczego komentuje się kod?

  • By pozwolić innym zrozumieć co robisz - jeżeli pracujesz z grupą ludzi nad jednym projektem, komentowanie kodu pozwoli im zrozumieć to co zmieniłeś, lub co zamierzasz wprowadzić,
  • By przypomnieć sobie wcześniejszą pracę - wielu programistów opracowuje własne projekty, po czym wraca do nich po kilku latach i przeprojektowuje. Komentowanie kodu przypomni Tobie jaką miałeś wtedy koncepcję i pozwoli uniknąć dekodowania własnej pracy,

1. Komentarz jednoliniowy

Jak dodać komentarz do kodu PHP? Istnieją trzy typy komentarzy, z których pierwszy jest jednoliniowy, i rozpoczyna się od dwóch slashy //.

<php
echo 'hello world';
// komentarz jednoliniowy nie wymaga zamknięcia
echo 'hello world';
?>

2. Komentarz jednoliniowy (inna wersja)

W następnym jednoliniowym komentarzu, na początek należy wstawić znak #.

<php
echo 'hello world';
# komentarz jednoliniowy nie wymaga zamknięcia
echo 'hello world';
?>

3. Komentarz wieloliniowy

Aby dodać dłuższy opis zawierający więcej informacji, można skorzystać z komentarza wieloliniowego.

<php
echo 'hello world';
/*
komentarz wieloliniowy wymaga zamknięcia
*/
echo 'hello world';
?>

Kategorie: PHP + MySQL. Tagi: #php, #skrypty. Źródło obrazków: Pixabay, Font awesome.

Zobacz także

4 komentarzy

Janusz
07.08.2023, 12:19
przydatne
Artur
11.04.2019, 16:36
Doskonały art, dzięki!
netmar
26.01.2015, 22:43
ok
Suchy
19.06.2010, 12:28
Oprócz powyższych powodów można też dopisać jak należy komentować skrypty, ponieważ jak ktoś zacznie po kolei komentować każdą linię to później też się nie połapie w kodzie ;). Ja u siebie też ostatnio napisałem na ten temat: http://free.xaa.pl/zalety-komentowania-skryptow/ ;)