PHP komentarze: stosowanie komentarzy w kodzie PHP


Stosowanie komentarzy w PHP

Tematem tej lekcji są komentarze. Rzecz, bez której bardzo trudno pracować przy dużych projektach programistycznych.

Nie tyczy się to wyłącznie PHP, ale każdego języka programowania. Zasada jest prosta – komentujmy wszystko, co może stać się niejasne po pewnym czasie. Na przykład napisanie kodu pewnej witryny zajęło tysiąc linijek, w których użyto pięćdziesięciu zmiennych.

Zleceniodawca przez pierwszy rok był bardzo zadowolony, lecz później stwierdził, że zamiast wyświetlać na stronie głównej dziesięć najnowszych produktów, chciałby, żeby było ich dwadzieścia i to w dodatku losowych. Zobaczmy więc jakie problemy możemy napotkać na swojej drodze.

Jeśli nazwaliśmy nasze zmienne $i, $j, $k, $zmienna1 itp. to bardzo ciężko będzie nam znaleźć odpowiedni fragment kodu. Musimy analizować krok po kroku składnię, żeby wywnioskować, co się dzieje w danym miejscu.

Wierzcie mi, że mimo iż podczas pisania wszystko wydaje się oczywiste, to po miesiącu już takie nie będzie. Wtedy z pomocą przychodzą nam komentarze. Jeśli komentowaliśmy skrupulatnie naszą pracę z pewnością szybko odszukamy odpowiedni fragment. Podsumowując, jeśli $ilosc jest odpowiedzialna za ilość produktów w sklepie, to należy ją obkomentować „Przechowuje ilość wszystkich produktów w sklepie”. Wtedy łatwo będzie nam ją odszukać i dokonać potrzebnych modyfikacji.

Genralnie, dobrze napisany kod nie wymaga komentowania każdej zmiennej.

PHP Komentarze w praktyce

Istnieją dwa sposoby umieszczania komentarzy w kodzie PHP. Pierwszy z nich stosujemy, gdy chcemy obkomentować kilka lub więcej linijek tekstu. Umieszczamy wtedy taki blok tekstowy między znakami ” /* ” oraz ” */ „. Wszystko zawarte pomiędzy tymi znacznikami zostanie zignorowane przez interpreter podczas generowania kodu html.

Co ważne, komentarze nie zostaną wysłane do przeglądarki użytkownika.

Drugim sposobem komentowania jest umieszczenie tekstu za dwoma ukośnikami ” // „. Jest to sposób szybszy i wygodniejszy od pierwszego z racji, że nie trzeba umieszczać znaków zamykających komentarz. Wszystko znajdujące się w jednym wierszu po tym oznaczeniu będzie traktowane jako komentarz. Obsługuje on jednak tylko jedną linijkę, więc jeżeli mamy długi tekst składający się z kilku wierszy, należy użyć pierwszego typu.

W kolejnej lekcji zajmiemy się już samą praktyką na przykładzie z życia wziętym. Będziemy obliczać kwotę netto i brutto zależnie od ilości zamówionych przez klienta przedmiotów. Wykorzystamy wiedzę zdobytą na dotychczasowych lekcjach w praktyce. Zapraszam serdecznie!

Spis lekcji w rozdziale pierwszym

Poprzednia lekcja: Operatory Następna lekcja: Podsumowanie działu

Kurs PHP i MySQL w formie wygodnego e-booka?

ZA DARMOPobieram kurs w formie e-booka