Komentuj JavaScript w HTML

Michael Zippo

Aby pisać komentarze HTML, wstaw <--- i ! - - -> na obu końcach komentarza. Komentarze HTML są znane z tego, że utrzymują porządek w kodzie HTML i są ignorowane przez przeglądarkę.

Jednym z najważniejszych aspektów oprogramowania dokumentacyjnego są pisemne komentarze do kodu. Komentarze to wiersze istniejące w programach komputerowych, które są ignorowane przez interpretery i kompilatory i są przeznaczone do czytania przez ludzi.

Pisanie komentarzy pozwala uczynić kod bardziej czytelnym i wskazać zawartość określonych części zrobiony program. Na przykład, jeśli piszesz długi program, możesz użyć komentarzy, aby śledzić określone funkcje lub wiersze kodu.

W tym samouczku dowiemy się, jak pisać komentarze w HTML. Zaczniemy od przyjrzenia się, dlaczego komentarze są używane w programowaniu. Następnie przyjrzymy się dwóm głównym typom komentarzy:. Komentarze jednowierszowe i wielowierszowe

Dlaczego programiści piszą komentarze

W HTML komentarze są ignorowane? przez przeglądarki i są usuwane, gdy kod jest kompilowany i minimalizowany. Dlaczego więc piszemy recenzje?

Komentarze są pisane tak, aby ludzie mogli je czytać i aby ułatwić zrozumienie kodu. Kiedy pracujesz nad pojedynczym projektem, łatwo jest pominąć komentarze, ponieważ jesteś jedyną osobą czytającą Twój kod. Jeśli jednak pracujesz nad dużym projektem, który zawiera złożony kod, możesz łatwo stracić z oczu cel swojego kodu.

Ponadto, jeśli pracujesz w zespole, inne osoby mogą nie rozumieć kodu. napisałeś. Jeśli tak się stanie, ludzie mogą być zmuszeni podążać za tobą, aby dowiedzieć się, jaki jest cel konkretnego kodu lub mogą pominąć linię kodu, nie rozumiejąc, co to znaczy i jak działa.

komentarze zapewniają szereg korzyści dla programistów. Po pierwsze, jak już omówiliśmy, komentarze ułatwiają zrozumienie kodu. Jeśli piszesz komentarze do swojego kodu, Ty i inne osoby, które go przeczytały, będzie łatwiej śledzić, co dzieje się w określonych punktach kodu

Po drugie , komentarze pozwalają programistom wyjaśnić ich rozumowanie stojące za decyzjami dotyczącymi programu. Może to być przydatne w sytuacjach, gdy program przestaje działać i wymaga naprawy błędu lub gdy programista potrzebuje większej jasności co do przyczyny do rozwiązania problemu zastosowano szczególne podejście. Komentarze mogą również przyspieszyć proces rozwoju, ponieważ łatwiej jest zrozumieć kod.

Komentarz HTML

Komentarze w języku HTML dokumenty są otoczone specjalnymi strzałkami i są oddzielone od reszty programu. Komentarze nie są wyświetlane przez przeglądarkę. Oto składnia podstawowego tagu komentarza HTML:

Gdy nasza strona internetowa jest otwarta, ten kod nie nie pojawiają się na naszej stronie internetowej. Zamiast tego kod pojawi się w naszym kodzie źródłowym do czytania.

Powyższy przykład to komentarz jednowierszowy , co oznacza, że tekst pojawi się tylko w jednym wierszu. Ten rodzaj komentarza jest przydatny, jeśli Twój komentarz będzie krótki. Jeśli jednak zamierzasz napisać długi komentarz, powinieneś użyć komentarza wielowierszowego .

Składnia wielowierszowych jest taka sama jak w przypadku jednowierszowych komentarzy , z tą różnicą, że komentarz jest na nowej linii produkcyjnej. Oto składnia wielowierszowego tagu komentarza:

Korzystanie z komentarzy HTML

Teraz, gdy już wiesz, jak pisać komentarze HTML, możesz się zastanawiać: kiedy należy dodawać komentarze do mojego kodu? Chociaż nie ma ścisłych wytycznych dotyczących wykorzystania opinii, a każdy programista i zespół ma swoje własne preferencje, jest kilka rzeczy, o których należy pamiętać.

Na ogół należy używać komentarzy:

Oczywiście istnieją inne sytuacje, w których można dodawać komentarze do kodu, ale są to najczęstsze.

Dodatkowo można również użyć Komentarze HTML do komentowania bloków tagów HTML. Pozwala to zachować wiersz kodu w programie, ale nakazuje przeglądarce ignorowanie go podczas renderowania strony internetowej HTML.

Komentowanie kodu poza programem jest powszechny podczas debugowania, ponieważ podczas debugowania musisz znaleźć przyczynę problemu i zaimplementować rozwiązanie, a pomocne może być powiedzenie programowi, aby zignorował kod bez całkowitego usuwania go z programu.Oto przykład używania komentarzy HTML do komentowania kodu:

jest przykładowym akapitem.

To kolejny przykład, akapit.

--->

Gdy nasza przeglądarka renderuje ten kod, drugi akapit jest ignorowany, ponieważ jest zawarty w komentarzach.

Komentarze HTML, chociaż są użyteczne, powinny być używane tylko wtedy, gdy dodają wartość do programu. Nie ma potrzeby dodawania komentarzy w celu wyjaśnienia wszystkich funkcji programu lub wyjaśnienia argumentów w znaczący sposób. Oto kilka wskazówek, o których należy pamiętać podczas pisania komentarzy HTML:

Wnioski

Korzystanie z komentarzy w języku HTML ułatwia tworzenie przypomnienia prog bardziej czytelny zarówno dla Ciebie, jak i dla innych osób, które chciałyby przeczytać Twój kod. Pisanie komentarzy w Twoim kodzie może ułatwić innym zrozumienie intencji Twojego kodu.

W tym samouczku omówiliśmy podstawy komentarzy i sposób tworzenia komentarzy w HTML. Omówiliśmy również, dlaczego komentarze są przydatne, i zbadaliśmy sprawdzone metody skutecznego pisania komentarzy . To powiedziawszy, każdy programista ma swój własny styl komentowania, a podczas pisania innych komentarzy znajdziesz że przyjmujesz własne.