Odpowiednio skomentowane znaczniki HTML są ważną częścią dobrze zbudowanej strony internetowej. Te komentarze są łatwe do dodania, a każdy, kto będzie musiał pracować nad tym kodem witryny w przyszłości (włączając w to siebie lub członków dowolnego zespołu, z którym pracujesz) podziękuje Ci za te komentarze.
Jak dodawać komentarze HTML
HTML może być autorem standardowego edytora tekstu, takiego jak Notepad ++ dla Windows lub TextEdit dla Mac. Możesz także skorzystać z programu do projektowania stron internetowych, takiego jak Adobe Dreamweaver lub nawet z platformy CMS, takiej jak Wordpress lub ExpressionEngine. Niezależnie od narzędzia, za pomocą którego tworzysz HTML, jeśli pracujesz bezpośrednio z kodem, dodasz komentarze HTML w ten sposób:
-
Dodaj pierwszą część tagu komentarza HTML:
-
Łącznie Twój komentarz będzie wyglądał mniej więcej tak:
-
To naprawdę takie proste.
Wyświetlanie komentarzy
Wszelkie komentarze dodane do kodu HTML pojawią się w tym kodzie, gdy ktoś wyświetli źródło strony internetowej lub otworzy kod HTML w edytorze, aby wprowadzić pewne zmiany. Ten tekst komentarza nie pojawi się jednak w przeglądarce internetowej, gdy odwiedzą go normalni użytkownicy. W przeciwieństwie do innych elementów HTML, w tym akapitów, nagłówków lub list, które faktycznie wpływają na stronę w tych przeglądarkach, komentarze są naprawdę "za kulisami" fragmentów strony.
Komentarze do celów testowych
Ponieważ komentarze nie pojawiają się w przeglądarce internetowej, można ich użyć do "wyłączenia" części strony podczas testowania strony lub programowania. Jeśli dodasz część otwierającą komentarza bezpośrednio przed częścią strony / kodu, którą chcesz ukryć, a następnie dodajesz część zamykającą na końcu tego kodu (komentarze HTML mogą obejmować wiele wierszy, dzięki czemu możesz otworzyć skomentuj linię 50 twojego kodu i zamknij ją na linii 75 bez żadnych problemów), wtedy wszystkie elementy HTML, które mieszczą się w tym komentarzu, nie będą już wyświetlane w przeglądarce. Pozostaną one w kodzie, ale nie wpłyną na wizualne wyświetlenie strony. Jeśli chcesz przetestować stronę, aby sprawdzić, czy dana sekcja powoduje problemy itp., Skomentowanie tego obszaru jest lepsze niż usunięcie go. W przypadku komentarzy, jeśli sekcja kodu, o którym mowa, okazuje się nie być problemem, możesz łatwo usunąć fragmenty komentarza, a ten kod zostanie wyświetlony ponownie. Upewnij się tylko, że te komentarze używane do testowania nie trafiają na strony produkcyjne.
Jeśli obszar strony nie powinien być wyświetlany, przed uruchomieniem tej witryny chcesz usunąć kod, a nie tylko go skomentować.
Wielkim użyciem komentarzy HTML podczas programowania jest budowanie responsywnej strony internetowej. Ponieważ różne części tej witryny zmieniają swój wygląd na podstawie różnych rozmiarów ekranu, w tym niektórych obszarów, które mogą nie być wyświetlane w ogóle, używanie komentarzy do przełączania sekcji strony może być szybką i łatwą sztuczką do wykorzystania podczas tworzenia.
Jeśli chodzi o wydajność
Widziałem, że niektórzy specjaliści od witryn internetowych sugerują, że komentarze powinny być usunięte z plików HTML i CSS, aby zmniejszyć rozmiar tych plików i utworzyć szybciej ładujące się strony. Chociaż zgadzam się, że strony powinny być zoptymalizowane pod względem wydajności i powinny być ładowane szybko, nadal istnieje miejsce na inteligentne wykorzystanie komentarzy w kodzie. Pamiętaj, że te komentarze mają na celu ułatwienie pracy w witrynie w przyszłości, tak długo jak nie zalegają z komentarzami dodanymi do każdego wiersza kodu, niewielka wielkość pliku dodana do strony z powodu komentarze powinny być więcej niż dopuszczalne.
Wskazówki dotyczące używania komentarzy
Kilka rzeczy, o których należy pamiętać lub pamiętać przy korzystaniu z komentarzy HTML:
- Komentarze mogą składać się z wielu linii.
- Użyj komentarzy do udokumentowania rozwoju strony.
- Komentarze mogą również dokumentować zawartość, wiersze tabeli lub kolumny, śledzić zmiany lub cokolwiek innego.
- Komentarze, które "wyłączają" obszary witryny, nie powinny jej uruchamiać, chyba że zmiana ta ma charakter tymczasowy, który zostanie w krótkim czasie odwrócony (jak na przykład włączenie lub wyłączenie komunikatu ostrzegawczego).
