Przeglądając stronę internetową w przeglądarce, widzisz wizualną reprezentację tego, co to oprogramowanie (przeglądarka internetowa) wyświetla na podstawie kodu danej strony internetowej. Jeśli wyświetlisz ten kod źródłowy strony, zobaczysz dokument złożony z różnych elementów HTML, w tym akapity, nagłówki, listy, linki, obrazy i inne. Wszystkie te elementy są renderowane przez przeglądarkę na ekranie odwiedzającego w ramach wyświetlania strony internetowej. Jedną z rzeczy, które można znaleźć w kodzie HTML, który nie jest renderowany na ekranie danej osoby, są tzw. "Komentarze HTML".
Co to jest komentarz?
Komentarz to ciąg kodu w HTML, XML lub CSS, który nie jest przeglądany lub obsługiwany przez przeglądarkę lub analizator składni. Jest po prostu wpisany w kod w celu dostarczenia informacji na temat tego kodu lub innych informacji zwrotnych od twórców kodu.
Większość języków programowania ma komentarze, są one powszechnie używane przez programistę kodu dla jednego lub więcej niż jednego z następujących powodów:
- Opisz i wyjaśnij skomplikowany kod osobie, która będzie musiała nad nią popracować w przyszłości - włączając w to siebie! Mogą wrócić do kodu 3 lub 6 z 12 miesięcy lub później i nie pamiętać, dlaczego zrobili coś w określony sposób. Komentarze mogą pomóc odpowiedzieć na ich pytania i przypomnieć im, gdzie znajdował się ich umysł podczas ich tworzenia.
- Podaj szczegóły dotyczące tego, kiedy kod był edytowany lub sprawdzany. Może to być pomocna informacja i działać trochę jak dziennik programowania, gdy strona była ostatnio przetwarzana.
- Usuń sekcje kodu, ale pozostaw je dostępne do późniejszego wykorzystania. Często odbywa się to podczas testowania witryny i debugowania. Jeśli masz problem z witryną i nie masz pewności, co go powoduje, możesz skomentować sekcje po jednej na raz, aby poddać kwarantannie i zidentyfikować problem, a następnie popracować nad rozwiązaniem problemów, które masz.
- Rozmawiaj z innymi programistami pracującymi nad kodem. Najprawdopodobniej zostanie to wykonane podczas programowania, aby udostępnić szczegóły innym osobom pracującym nad kodem w tym samym czasie. Jeśli te komentarze dotyczą wyłącznie rozmów programistycznych, najlepiej jest usunąć je z kodu przed uruchomieniem witryny.
Tradycyjnie komentarze w HTML są używane w prawie każdym elemencie, od wyjaśnień złożonych struktur tabel do informacji na temat treści samej strony. Ponieważ komentarze nie są renderowane w przeglądarce, możesz dodać je w dowolnym miejscu w kodzie HTML i nie martwić się, co zrobi, gdy witryna zostanie wyświetlona przez klienta.
Jak pisać komentarze
Pisanie komentarzy w HTML, XHTML i XML jest bardzo łatwe. Po prostu otaczaj tekst, który chcesz skomentować:
i
Jak widać, komentarze te zaczynają się od "mniej niż symbolu", plus wykrzyknik i dwa kreski. Komentarz kończy się dwoma dodatkowymi myślnikami i znacznikiem "większy niż:" Pomiędzy tymi znakami możesz napisać cokolwiek chcesz, aby utworzyć treść komentarza.
W CSS jest trochę inaczej, używając komentarzy w kodzie C niż w HTML Zaczynasz od ukośnika, a następnie gwiazdki. Kończymy komentarz odwrotnością tego, gwiazdką, po której następuje kreska ukośna.
Komentarze są Dying Art
Większość programistów zna wartość użytecznych komentarzy. Skomentowany kod ułatwia przeniesienie tego kodu z jednego członka zespołu do drugiego. Komentarze pomagają zespołowi kontroli jakości w testowaniu kodu, ponieważ mogą powiedzieć, co zamierzał programista - nawet jeśli nie został osiągnięty. Niestety, wraz z popularnością platform do tworzenia stron internetowych, takich jak Wordpress, które pozwalają na rozpoczęcie pracy z wybranym motywem, który obsługuje wiele, jeśli nie wszystkie, HTML dla Ciebie, komentarze nie są używane tak często przez zespoły internetowe. Wynika to z faktu, że komentarze nie są widoczne w większości narzędzi do wizualnego authoringu, jeśli nie pracujesz bezpośrednio z kodem. Na przykład zamiast widzieć na górze strony:
Narzędzie wizualne pokazuje maleńką ikonę wskazującą, że istnieje komentarz. Jeśli autor nie otworzy fizycznie komentarza, może go nigdy nie zobaczyć. W przypadku powyższej strony może powodować problemy, jeśli edytuje stronę, a edycja jest nadpisana przez skrypt wspomniany w komentarzu.
Co można zrobić?
- Napisz znaczące i użyteczne komentarze. Nie oczekuj, że inne osoby będą czytać twoje komentarze, jeśli są zbyt długie lub nie zawierają pomocnych informacji.
- Jako programista powinieneś zawsze przejrzyj wszystkie komentarze na stronie.
- Użyj narzędzi dostępnych w programach tworzenia treści, które umożliwiają dodawanie komentarzy.
- Zarządzaj zawartością, aby kontrolować sposób edytowania stron.
Nawet jeśli jesteś jedyną osobą, która edytuje twoje strony internetowe, komentarze mogą być przydatne. Jeśli edytujesz skomplikowaną stronę raz w roku, łatwo zapomnieć, jak zbudowałeś tabelę lub złożyć CSS. Dzięki komentarzom nie musisz pamiętać, ponieważ jest napisane dla Ciebie.
