W tej lekcji opowiem o tym, jak to zrobić komentarze w HTML, CSS, PHP. Komentarze to tekst, który nie jest widoczny na stronie internetowej. Wykorzystywane są do różnego rodzaju objaśnień, przypomnień i opisów dla webmasterów, co pozwala na uporządkowanie dokumentu. Komentarze są niezbędne podczas debugowania kodu, pozwalają szybko poruszać się po znacznikach strony internetowej i znaleźć żądany blok. Komentarze są często używane do debugowania kodu HTML. Można na przykład tymczasowo skomentować konkretny blok kodu, aby nie został on wykonany, a w razie potrzeby można go łatwo przywrócić.
Komentarze w HTML
W HTML komentarze są tworzone przy użyciu następujących znaków:. Zatem dowolny tekst pomiędzy tymi znakami jest komentarzem. Spójrzmy na przykład:
Przykład komentarzy w HTML
Komentarze w CSS
Komentarze w CSS tworzone są przy użyciu znaków: /* i */. Aby utworzyć komentarz, wystarczy umieścić kod strony internetowej pomiędzy tymi znakami:
/* Początek bloku ze stylami treści*/ body ( tło: #efeded; rodzina czcionek: Verdana, Helvetica, bezszeryfowa; rozmiar czcionki: 12px; margines: 0px; dopełnienie: 0px; ) /* Koniec blok ze stylami dla Body*/
Komentarze w PHP
Komentarze w PHP mogą być jedno- lub wieloliniowe:
1) Komentarze jednoliniowe w PHP tworzone są przy użyciu znaków: //. Wystarczy umieścić ten znak na początku linii, a zostanie on zakomentowany. Opcja ta stosowana jest w przypadku, gdy komentarz składa się tylko z jednej linii.
2) Aby zaimplementować komentarze wieloliniowe, używane są następujące symbole: /* i */. Ta opcja jest przydatna, jeśli komentarz obejmuje kilka wierszy.
Więc nauczyliśmy się to robić
... dzisiaj w tym krótkim, ale przydatnym artykule dowiemy się, jak komentowane są różne kody programów. Nie będę wiele mówił, bo jeśli Cię to interesuje, to zetknąłeś się już z tematyką tego problemu i masz o nim pojęcie.
Dobrze trafiłeś...ale kilka słów dla jasności i korzyści dla sprawy. Prawdopodobnie widziałeś, jak to się robi za pomocą kodu CSS, ponieważ CSS jest przedmiotem największego zainteresowania wielu początkujących, takich jak ja.
… Cienki!
Należy jednak pamiętać, że komentarze są również używane w HTML i PHP... Ale większość początkujących jest zdezorientowana na początkowym etapie pracy z witryną i nie wie, jak dodać do siebie niezbędne wyjaśnienia. Przecież zdarza się, że trzeba np. dezaktywować na jakiś czas Kod HTML, a następnie ponownie wznów jego funkcję - jest to łatwe do wdrożenia, jeśli zrobiłeś notatki na „marginesach”, ale nigdy nie wiadomo.
Ale ogólnie rzecz biorąc, jeśli chodzi o „komentarze”, powinieneś pamiętać, że wszystko zależy ściśle od tego, z jakim plikiem pracujesz, dlatego kod aplikacji jest inny.
Komentowanie kodu CSS
a:hover, a:focus ( kolor: #D5071E; dekoracja tekstu: Nadkreślenie; /*PODKREŚLENIE GÓRY*/ )W ten sposób dajesz sobie wyjaśnienie. Możesz nawet skomentować ten skrypt CSS w ten sposób: po prostu zawiń
/* KOD tutaj */
/*a:hover, a:focus ( kolor: #D5071E; dekoracja tekstu: podkreślenie; /* PODKREŚLENIE PONIŻEJ*/ )*/
Zwracam uwagę na fakt, że można w ten sposób skomentować cały cykl kodu CSS, ale!! wtedy będziesz musiał usunąć powtarzające się komentarze /* PODKREŚLENIE NA DOLE*/ lub pobawić się ukośnikami, jeśli wyjaśnienie jest ważne))
W przeciwnym razie wystąpi błąd!!
Notatka:
Jeśli otworzysz kod źródłowy strony - Ctrl+U i rzucisz okiem... zobaczysz, że skomentowany fragment kodu CSS jest doskonale wyświetlony w wygenerowanym dokumencie! dzieje się tak, jeśli użyto css (ustawiono właściwości) bezpośrednio w HTML
I, jak rozumiesz, jeśli przejdziesz z kodu źródłowego poprzez link do dokumentu css aktywnego szablonu, wszystkie komentarze będą mogły być obserwowane i przestudiowane)), jeśli ktoś tego potrzebuje. Ale to mało prawdopodobne)
Angielski przysłówek (słowa) będzie czytelny. Symbole rosyjskie - nie.
Komentowanie kodu HTML
Plik XML jest komentowany w ten sam sposób
Ważne: zawsze sprawdzaj kod oferowany w artykułach, przynajmniej wizualnie), w przeciwnym razie mogą wystąpić błędy.
Zwykła nieostrożność podczas formatowania może kosztować czas, na przykład skomentowany kod pokazany powyżej jest często błędny: Zamiast dwóch krótkich łączników pojawia się długa myślnik:
Dla Twojej informacji:
jak wspomniano w poprzedniej uwadze, to samo tyczy się komentarza... W wygenerowanym dokumencie wyświetlany jest kod HTML!
Pamiętaj o tym.
A oto kolejna rzecz:
Oprócz tego, że skomentowany kod jest wyświetlany w kodzie źródłowym strony (a zatem jest w pewnym sensie przetwarzany, chociaż na stronie będzie niewidoczny!) - lepiej usunąć niektóre funkcje PHP w połączeniu z html z aktywnego dokumentu.
Na przykład:
będą widoczne w dokumencie i funkcjispełni swoje zadanie znakomicie: czyli informacja nie będzie już widoczna w interfejsie, ale w kodzie źródłowym będzie wyraźnie widoczna! i to jest bezsensowne zapytanie do bazy danych: to wszystko drobnostka, ale trzeba wiedzieć!
Można to zrobić, jeśli nie chcesz usuwać fragmentu kodu z dokumentu:
dodaj przed niezbędnym „dodatkowym” kodem HTML otwór...wbudowana funkcja ... i zamykanie?> ...
Krótko mówiąc, oto, co możesz zrobić, jeśli kod jest duży:
wtedy źródło będzie czyste!
Lub prościej:
Skomentujmy samą funkcję w dokumencie HTML. Kod źródłowy w tych przypadkach dotyczących rozwoju funkcji będzie czysty!
jak skomentować JavaScript
if (pokazany || pokazany) ( // nie uruchamiaj ponownie animacji return; ) else ( // zastosuj DOWOLNY KOMENTARZ w linii // zastosuj DOWOLNY KOMENTARZ w linii // true;Dla przejrzystości pobrałem ten przykładowy kod JavaScript z Internetu, lekko poprawiając interpunkcję. To nie ma znaczenia... Najważniejsze jest, aby zrozumieć zasadę...
Jak rozumiesz, podwójny ukośnik „//” to ZNAK komentarza... POJEDYNCZA LINIA!
Reszta kodu JS jest komentowana jak php, więcej na ten temat poniżej:
uwaga:
Komentowanie kodu PHP
...i...tutaj jest podobnie – ukośnik...jedna linia.Pamiętaj jednak, że można go komentować tak samo jak kod CSS.
...lub możesz to skomentować w ten sposób - wersja jednoliniowa, gdy używamy NIE DWÓCH Ukośników, ale BECAR (hash) przed skomentowaną linią:
...Naturalnie, musisz uważnie komentować w pętli kodu!
...lub w ten sposób - podobnie jak w przykładzie pokazanym powyżej dla CSS... tj. ta /* kod */ opcja komentowania jest odpowiednia zarówno dla kodów CSS, jak i JS!
Ale w ten sposób możesz skomentować obszerniejsze wyjaśnienie kodu PHP, gdzieś pomiędzy jego głównymi przykładami...
W ten sposób możesz także komentować pętle PHP, jeśli kod jest mieszany... php i jakoś html
To samo, co opisano powyżej:
Na przykład jakaś taka funkcja... gdzieś w kodzie ogólnym (lub pętla w HTML):— możesz to skomentować, czyli dodać własną etykietę w ten sposób:
lub tak: opcja jednowierszowa...
Inteligencja:
kod php nie jest widoczny w żadnym kodzie źródłowym!! Widoczny jest tylko efekt funkcjonalny – trening!
To w zasadzie wszystko, co chciałem dzisiaj zgłosić!
Teraz możesz eksperymentować... Powodzenia.
I oczywiście przeczytaj artykuły na stronie i zasubskrybuj:
Dzielę się swoim gorzkim doświadczeniem - trochę wiedzy, dla twojego słodkiego dobrego samopoczucia))
...miasto webmasterów Mihalika.ru© - łatwo z WordPressem
Od autora: Komentowanie to jedna z tych funkcji, którą można łatwo wdrożyć. Jednocześnie te elementy edycyjne mogą przynieść wiele korzyści programistom, którzy przenoszą kod z rąk do rąk. Dziś dowiesz się jak skomentować blok w PhpStorm. Rozważymy także pozostałą funkcjonalność środowiska programistycznego do komentowania treści programu.
Komentarze: złe i dobre
Możliwość komentowania kodu jest dostępna w większości języków programowania (być może we wszystkich, ale z różnym stopniem dostępności). Zazwyczaj wyjaśnienia ustne służą pomocy innym członkom zespołu w dalszym rozwoju lub po prostu przypominają sobie, że dany obszar wymaga poprawek („NAPRAW MNIE”).
Oczywiście wyjaśnienie tego, co jest napisane, jest błogosławieństwem. Ale za pomocą komentarzy możesz przekreślić wszystkie dobre aspekty kodu. Aby temu zapobiec, należy rozróżnić rodzaje komentarzy:
dokumentowanie. Dobrym skojarzeniem byłaby koncepcja dokumentacji dla różnych programów. Takie komentarze pomagają w korzystaniu z kodu, podobnie jak instrukcje. Taki komentarz nie jest postrzegany jako zbędny, bo bez niego nie ma mowy. Wyobraź sobie, że ktoś korzysta z autorskiego frameworka i nie mówi Ci, jak korzystać z programu;
JavaScript. Szybki start
wyjaśniający. Dobry kod zwykle ich nie potrzebuje. Im więcej wierszy komentarzy widzisz w programie, tym większe jest prawdopodobieństwo, że program jest źle napisany. Oczywiście nie jest to reguła absolutna.
Komentarze wyjaśniające mogą być przydatne dla tych, którzy będą poprawiać kod w przyszłości. Na przykład wielu młodych profesjonalistów wszędzie widzi miejsce na ulepszenia. Wierzą, że przed nimi wszystko było gorsze, a teraz nadszedł czas, aby naprawić każdą pojedynczą funkcję.
Czasami podobne uczucie ogarnia także profesjonalistów. Na przykład, gdy wszystko wygląda zaskakująco krzywo, musi istnieć lepsze rozwiązanie. Aby uchronić obserwujących przed szukaniem czegoś lepszego, programista może zostawić notatkę w stylu: #time_spent_here=24h
Po takich słowach niewiele osób będzie chciało spędzić tak dużo czasu. W ten sposób ostrzegasz, że wypróbowano już wiele różnych opcji. Jednocześnie należy unikać takich ataków: #i_hate_this, #try_to_do_better_ass%%le. W ten sposób okazujesz jedynie nieprofesjonalne podejście. Nie powinieneś narażać siebie i swojego pracodawcy.
Ale dokumentowanie komentarzy do kodu może być także balastem dla programisty. Z reguły są to ogromne obszary, które bezpośrednio odwracają uwagę od programowania. Aby jednak wyświetlić kod bez komentarzy, główne IDE mają odpowiednią funkcję. PhpStorm nie powinien być wyjątkiem, ale niestety. Poszukaj tej funkcji w dokumentach aktualizacji.
Etykieta jako element funkcjonalny
Chociaż komentowanie miało na celu wyjaśnienie i pomoc w rozwoju zespołu, funkcje te nie są używane zbyt często. Z reguły tagi umieszczane są tam, gdzie chcą zatrzymać wykonanie kodu. Wyobraźmy sobie, że masz PHP osadzone w HTML. I nie chcesz go usuwać, ale chcesz po prostu zobaczyć, jak strona wygląda bez niego. Aby to zrobić, musisz postępować zgodnie z następującą składnią:
JavaScript
…
…< div > . . . < / div > < ? -- закомментированныйкоднаphp -- > < div > . . . < / div > |
Jak widać prostymi akcjami można zatrzymać wykonanie kodu nawet bez wykonywania skomplikowanych operacji. Ale w rzeczywistości nie jest to szczyt optymalizacji. Dodatkową wygodę dla programisty zapewnia samo phpStorm IDE. Za pomocą podświetlania i skrótów klawiaturowych możesz skomentować wybrany segment kodu bez przypisywania wyspecjalizowanych tagów. Można to zrobić w ten sposób.
W dogodny dla siebie sposób zaznacz fragment tekstu (mysz, skróty).
Naciśnij kombinację klawiszy Ctr + Shift + /
Dodatkowo możesz skomentować bieżącą linię. Wszystko jest takie samo, tylko bez Shiftu.
Zaletą tego typu komentowania jest jednoczesne uwzględnienie kilku języków. PHP rzadko występuje samodzielnie. Dzięki temu nie będziesz musiał uciekać się do tagowania każdego z nich. Środowisko obsługuje kilka innych języków internetowych. Wystarczy wybrać fragment i sprzedać kombinację - jest to wielojęzyczny kod i skomentowany. W ten sam sposób można go aktywować.
To wszystko dla nas. Jeśli nie korzystałeś wcześniej z tych funkcji, zachęcamy Cię do rozpoczęcia. Skróty sprawiają, że praca jest szybsza i lepsza.
JavaScript. Szybki start
Naucz się podstaw JavaScriptu na praktycznym przykładzie tworzenia aplikacji internetowej.
25.04.2017
Cześć wszystkim!
Kontynuujmy naukę podstaw PHP od zera!
W tej lekcji opowiem Wam czym jest komentarz w PHP i w praktyce spróbujemy napisać własny komentarz w kodzie. Ale to nie wszystko. Chcę również powiedzieć, jak skomentować kod i dlaczego trzeba to zrobić.
W czym jest komentarzPHP
SkomentujPHP– jest to wskazówka dla programisty PHP, aby szybko poruszać się po kodzie, a także do edycji.
Komentarz w PHP nie jest widoczny dla użytkownika, który otworzył stronę do przeglądania. Nawet jeśli użytkownik zdecyduje się zajrzeć do kodu źródłowego strony, komentarz nadal nie będzie widoczny, ponieważ nie będzie widoczny cały kod php.
Komentarz do kodu PHP
Istnieją 2 rodzaje komentarzy do kodu PHP:
→ jednolinijkowy
→ wielowierszowe
⇒ Jednowierszowy komentarz dla PHP
W przypadku komentarza jednowierszowego użyj znaków „//” lub „#”
Po tych znakach wszystko, co zostanie zapisane w jednej linii, zostanie zignorowane i uznane za komentarz.
Zapisz się do aktualizacji"; # subskrypcja (to jest komentarz) ?>
Zapisz się, aby zaktualizować
⇒ Komentarz wielowierszowy dla PHP
Wielowierszowy komentarz w PHP zaczyna się od znaku „/*” i kończy znakiem „*/”.
Wszystko pomiędzy tymi znakami będzie ignorowane i traktowane jako komentarz.
Komentarz wielowierszowy jest używany, jeśli post zawiera kilka wierszy.
Na ekranie zobaczysz tylko ten tekst:
Witajcie czytelnicy bloga - strona!!!
PS: Zawsze komentuj swój kod. Jeśli myślisz, że za 1-2 lata będziesz pamiętał wszystko, co zrobiłeś w kodzie, to się mylisz, szansa jest bardzo mała. Nawet jeśli pamiętasz, będziesz musiał spędzić dużo czasu na nauce - co, gdzie i dlaczego...
Zrób coś miłego dla swojej przyszłej siebie - skomentuj kod, a wtedy powiesz sobie „DZIĘKUJĘ!!!”
Zostaw komentarz w kodzie, zajmie to 1 minutę, ale pozwoli Ci zaoszczędzić cały dzień w przyszłości.
Skomentuj kod PHP
Załóżmy, że napisałeś kod PHP, ale z jakiegoś powodu musisz usunąć 2 linie z kodu.
Nie spieszę się z usuwaniem czegoś z kodu, zwłaszcza jeśli jest to kod PHP, wolę to skomentować. A co jeśli będziesz musiał zwrócić kod? Łatwiej odkomentować niż napisać kod w nowy sposób.
Jak skomentować kod wPHP
Przykład z jednowierszowym komentarzem:
Zapisz się, aby zaktualizować"; ?>
Przykład z komentarzem wielowierszowym.
