Dodawanie komentarzy w plikach w formacie HTML, CSS, PHP!

Czas czytania: 3 minut

Praktycznie w każdym języku skryptowym w tym też programowania mamy możliwość umieszczania komentarzy.

Po co nam komentarze w kodzie witryny?

Komentarze mogą pełnić rożne funkcje np.

• do zaznaczania gdzie kończy się i zaczyna dana sekcja kodu – dzięki czemu tworzy się czytelniejszy kod
• do tworzenia notatek (np. ułatwiających nam późniejsze edytowanie strony)
• mogą pełnić rolę informacyjną o tym do czego jest dany fragment kodu (przydatne jeśli wrócili byśmy np. do strony po jakiś czasie)
• do tymczasowego wyłączenia elementu na stronie, kodu
• i wielu innych czynności

Dają nam więc całkiem sporo możliwości choć na początku nauki programowania można nie zdawać sobie z tego sprawy.

Komentarze w większości języków bardzo łatwo się dodaje jak i je usuwa. Dlatego też dodawanie ich nie powinno nikomu sprawić problemu, co najwyżej pytanie brzmi jakiego użyć.

UWAGA: Zawartość umieszczona między odpowiednimi znacznikami komentarza jest widoczna w źródle strony, nie jest jednak interpretowana przez przeglądarkę. 

Dodawanie komentarzy w HTML

W plikach zapisanych w formacie HTML dodajemy komentarze za pomocą znacznika:

<!-- tutaj komentarz w html -->

Zawartość komentarza umieszczamy pomiędzy tym znacznikiem <!– a znacznikiem –> jest ona nie widoczna po wyświetleniu się strony. Jednak kiedy wejdziemy w jej kod będzie ona widoczna. Jest tak dlatego, że tekst umieszczony w tym znaczniku nie jest jedynie wyświetlany przez przeglądarkę internetową.

Znacznikiem tym możemy objąć jedną linię (utworzyć komentarz liniowy) lub kilka linijek kodu.

Dodawanie komentarzy w CSS, PHP, JavaScript

W przypadku CSS, PHP, JavaScript, C++ i Java komentarze tworzymy w praktycznie w ten sam sposób. Poniżej przykłady:

Komentarze w CSS

.abc{
color: #333;
/* 
treść bloku z komentarzem
  */
}

Przykład dla komentarza w kodzie PHP

<?php
/*

Ten komentarz ma początek i koniec
Nie będzie go widać

*/
echo "Witaj świecie";

?>

Przykład komentarza dla kodu w JavaScript

<script>
 /* 
Blok z komętarzem w JavaScript 
Może znaleźć się tutaj kilka linijek kodu

*/ 
$('.bootomtext').remove().insertAfter($('.bootom-ads'));

</script>

Objaśnienia

/* – otwarcie komentarza

*/ – zamknięcie komentarza

Wszystko co znajduje się pomiędzy znacznikami będzie wchodziło w skład komentarza. W praktyce zawartość komentarza w języku CSS i JS będzie podobnie jak w przypadku HTML widoczna kiedy zajrzymy w kod strony w przeglądarce internetowej.

Inaczej sytuacja wygląda w przypadku PHP. PHP jest jeżykiem interpretowanym przez serwer. Tak więc do naszej przeglądarki trafia już zinterpretowany kod – bez widocznych komentarzy.

Komentarze jednoliniowe w JavaScript i PHP

W JavaScript (dotyczy to również jQuery) i PHP komentować możemy też samą 1 linijkę. Dzięki czemu nie musimy już takiego komentarza zamykać. Wygląda to np. następująco w PHP

// to jest komentarz w jednej linijce

Jak widać umieściłam tu tylko na początku linijki dwie ukośne linie // . W efekcie czego treść kodu lub tekst za nimi do końca wiersza zostanie pominięty na stronie.

Podsumowanie

Jak widzicie dodanie komentarza do kodu HTML lub CSS to żadna filozofia. Mimo to na początku możecie mieć małe problemy 🙂 bo przede wszystkim trzeba zapamiętać jak wygląda taki znacznik. Warto też pamiętać, że jeśli otworzycie komentarz i go nie zamkniecie może to spowodować za komentowanie dalszej części treści pliku.

Dodatkowo komentarze w HTML spotykane są również przy określaniu warunków dla niektórych typów przeglądarek. np.:

<!--[if IE]> 
Tekst widoczny w Internet Explorer 
<![endif]-->

Jak widać więc w HTML komentarze potrafią być wielofunkcyjne.

Jeżeli chcecie dowiedzieć się trochę więcej o komentarzach możecie poczytać na stronie:

https://developer.mozilla.org/en-US/docs/Web/CSS/Comments