Od autora: komentowanie to jedna z tych funkcji, którą można łatwo wdrożyć. Jednocześnie te elementy edycyjne mogą być bardzo przydatne dla programistów przekazujących kod z rąk do rąk. Dziś dowiesz się jak skomentować blok w PhpStorm. Pozostałą funkcjonalność środowiska deweloperskiego rozważymy także w celu skomentowania zawartości programu.
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). Zwykle wyjaśnienia ustne służą innym członkom zespołu w dalszym rozwoju lub po prostu przypominają sobie, że ten obszar wymaga poprawek („NAPRAW MNIE”).
Oczywiście wyjaśnienie tego, co zostało napisane, jest błogosławieństwem. Ale za pomocą komentarzy możesz przekreślić wszystkie dobre strony kodu. Aby temu zapobiec, należy rozróżnić rodzaje komentarzy:
dokumentowanie. Dobrym skojarzeniem byłaby koncepcja dokumentacji dla różnych oprogramowanie. Takie komentarze pomagają w korzystaniu z kodu, niczym instrukcja. Taki komentarz nie jest postrzegany jako zbędny, bo bez niego nie ma mowy. Wyobraź sobie, że ktoś korzystał z frameworka autorskiego i nie mówi Ci, jak korzystać z programu;
JavaScript. Szybki start
wyjaśniający. dobry kod zwykle nie są potrzebne. 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 profesjonalistów. Na przykład, gdy wszystko wygląda zaskakująco krzywo – musi istnieć lepsze rozwiązanie. Aby powstrzymać obserwujących przed szukaniem czegoś lepszego, programista może zostawić notatkę w stylu: #time_spent_here=24h
Po takich słowach niewiele osób chce spędzić tak dużo czasu. Więc często to ostrzegasz różne opcje już przejęte. 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 narażaj siebie i pracodawcy.
Ale dokumentowanie komentarzy do kodu może również stać się balastem dla programisty. Z reguły są to obszerne sekcje, które bezpośrednio odwracają uwagę od programowania. Aby jednak wyświetlić kod bez komentarzy, w głównych IDE dostępna jest odpowiednia funkcja. Nie powinno być wyjątkiem i PhpStorm, ale niestety. Poszukaj tej funkcji w dokumentach aktualizacji.
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. Załóżmy, że masz PHP osadzone w HTML. I nie chcesz go usuwać, 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 jeszcze 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 skrót klawiaturowy Ctr + Shift + /
Ponadto możesz komentować bieżącą linię. Wszystko to samo, tylko bez Shift.
Zaletą tego typu komentowania jest jednoczesne uwzględnienie kilku języków. PHP samo w sobie jest rzadkością. Dzięki temu nie będziesz musiał uciekać się do tagowania każdego z nich. Środowisko obsługuje kilka innych języków internetowych. Po prostu wybierz fragment i sprzedaj kombinację - to wielojęzyczny kod i skomentowany. W ten sam sposób można go aktywować.
To wszystko, co mamy. 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
Poznaj podstawy JavaScriptu na praktycznym przykładzie budowy aplikacji internetowej
W tej lekcji pokażę ci, jak to zrobić komentarze w HTML, CSS, PHP. Komentarze to tekst, który nie jest widoczny na stronie internetowej. Wykorzystywane są do wszelkiego rodzaju objaśnień, przypomnień, 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 łatwo go przywrócić.
W HTML komentarze są tworzone przy użyciu znaków:. Zatem dowolny tekst pomiędzy tymi znakami jest komentarzem. Rozważmy przykład:
Przykład komentarzy w HTML
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; padding: 0px; ) /* Koniec bloku ze stylami dla Body*/
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 przed linią i zostanie on zakomentowany. Opcję tę stosuje się 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 wiele wierszy.
W ten sposób nauczyliśmy się
Komentarze w PHP są podobne do komentarzy używanych w HTML. W składni PHP komentarze zawsze zaczynają się od specjalnej sekwencji znaków, a każdy tekst pojawiający się pomiędzy tymi znakami specjalnymi będzie ignorowany przez interpreter.
W HTML głównym celem komentarza jest przekazanie programistom informacji, którzy mogą przeglądać kod źródłowy Twojej witryny. Komentarze PHP różnią się tym, że nie będą wyświetlane odwiedzającym. Jedynym sposobem wyświetlenia komentarzy PHP jest otwarcie pliku do edycji. To sprawia, że komentarze PHP są przydatne tylko dla programistów PHP.
Jeśli zapomniałeś lub nie wiedziałeś, jak tworzy się komentarze w HTML, zobacz poniższy przykład.
Podczas gdy HTML ma tylko jeden typ komentarza, PHP ma dwa typy. Pierwszym typem, który omówimy, jest komentarz jednoliniowy. Oznacza to, że komentarz mówi interpreterowi, aby zignorował wszystko, co dzieje się w wierszu po prawej stronie komentarzy. Aby użyć tego komentarza, użyj znaków „//” lub „#”, a cały tekst po prawej stronie zostanie zignorowany przez interpreter PHP.
Psst...Nie możesz zobaczyć moich komentarzy PHP!"; // echo „nic”; // echo "Nazywam się Humperdinkle!"; # echo "Ja też nic nie robię"; ?>
Wynik:
Witaj świecie! Psst... Nie możesz zobaczyć moich komentarzy PHP!
Należy pamiętać, że kilka naszych poleceń echo nie zostało przetworzonych, ponieważ skomentowaliśmy je specjalnymi znakami komentarza. Tego typu komentarz jest często używany do szybkiego pisania o złożonym i zaciemnionym kodzie lub do tymczasowego usunięcia linii kodu PHP (w celach debugowania).
Podobnie jak komentarze HTML, wielowierszowe komentarze PHP mogą być używane do komentowania dużych bloków kodu lub do pisania komentarzy w wielu wierszach. Komentarze wielowierszowe w PHP zaczynają się od „/*” i kończą na „*/”. Wszystko pomiędzy tymi znakami zostanie zignorowane.
Wynik.
... dzisiaj jesteśmy w tym krótkim, ale przydatnym artykule, dowiemy się, jak komentowany jest kod różnych programów. Nie będę dużo mówił, bo jeśli Cię to interesuje, to zetknąłeś się już z pytaniami tego zadania i masz o tym pojęcie.
Trafiłeś we właściwe miejsce... ale kilka słów dla jasności i użyteczności. Musiałeś widzieć, jak to się robi z kodem CSS, ponieważ CSS jest najbardziej interesujący dla 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ż dzieje się to w ten sam sposób, na przykład trzeba dezaktywować na jakiś czas Kod HTML, a następnie ponownie wznów jego funkcję - jest to łatwe do wdrożenia, jeśli robisz notatki na „marginesach”, ale nigdy nie wiesz co.
Ale o czym należy pamiętać w ogóle o „komentarzach” - wszystko tutaj jest ściśle zależne od tego, z jakim plikiem konkretnie pracujesz, dlatego kod aplikacji jest inny.
W ten sposób możesz się wytłumaczyć. Możesz też ogólnie 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 DOLNE*/ )*/
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 /* PODCIĄG PONIŻEJ */ 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... zobaczymy, ż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 podążysz za linkiem z kodu źródłowego do dokumentu css aktywnego szablonu, możesz obserwować i przestudiować wszystkie komentarze)), jeśli ktoś tego potrzebuje. Ale to mało prawdopodobne.)
Dialekt angielski (słowa) będzie czytelny. Symbole rosyjskie - nie.
Plik XML jest komentowany w ten sam sposób.
Ważne: zawsze sprawdź kod zaproponowany w artykułach, przynajmniej wizualnie, w przeciwnym razie mogą pojawić się błędy.
Nieostrożność w prostym formatowaniu może kosztować czas, na przykład kod KOMENTOWANY pokazany powyżej jest często błędny: zamiast dwóch krótkich łączników pojawia się myślnik:
Dla Twojej informacji:
jak wspomniano w poprzedniej uwadze - tak samo jest z komentarzem... kod HTML zostanie wyświetlony w wygenerowanym dokumencie!
Pamiętaj o tym.
A oto coś jeszcze:
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 wyjątkowo dobrze: czyli w front-endzie informacja nie będzie widoczna, ale w kodzie źródłowym będzie wyraźnie widoczna! i to jest bespontovy wniosek do bazy danych: to wszystko drobnostka, ale musisz wiedzieć!
Można to zrobić, jeśli nie chcesz wyciągać fragmentu kodu z dokumentu:
dodaj przed niezbędnym „dodatkowym” otwarciem kodu HTML… funkcja inline… i zamknięcie?> …
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!
Ten przykładowy kod JavaScript - dla jasności chwyciłem z sieci, lekko poprawiając interpunkcję. To nie ma znaczenia... Najważniejsze jest, aby zrozumieć zasadę...
Jak rozumiesz, ukośnik „//” jest podwójny, to jest ZNAK komentarza… JEDNA LINIA!
Reszta kodu JS jest komentowana jak php , więcej na ten temat poniżej:
notatka:
Pamiętaj jednak, że można go komentować tak samo jak kod CSS.
... lub możesz skomentować w ten sposób - wersja jednowierszowa, gdy przed skomentowaną linią używamy NIE DWÓCH UKOŃCÓW, ale BEKAR (hash):
…Oczywiście, komentowanie powinno odbywać się ostrożnie w pętli kodu!
... lub w ten sposób - podobnie jak w przykładzie CSS pokazanym powyżej ... 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…
Możesz także komentować w cyklach php, jeśli kod jest mieszany ... php i jakoś html
Podobnie jak powyżej:
Na przykład jakaś taka funkcja... gdzieś w kodzie ogólnym (lub pętla w HTML):- możesz skomentować, czyli dodać swoją etykietę w ten sposób:
lub tak: jednolinijkowy…
Inteligencja:
kod php nie jest widoczny w żadnym kodzie źródłowym!! widoczny jest tylko wynik funkcjonalny – działa!
To 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 Michalika.ru© - łatwo z WordPressem
25.04.2017
Cześć wszystkim!
Kontynuujemy naukę podstaw PHP od podstaw!
W tej lekcji opowiem Ci czym jest komentarz w PHP i w praktyce postaramy się napisać Twój komentarz w kodzie. Ale to nie wszystko. Chcę również powiedzieć, jak skomentować kod i dlaczego w ogóle należy to robić.
W czym jest komentarzPHP
SkomentujPHP to wskazówka dla programistów php umożliwiająca szybką orientację w kodzie, a także edycję.
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ż wszystkie pliki php.
Istnieją 2 rodzaje komentarzy do kodu PHP:
→ jednolinijkowy
→ wielowierszowe
⇒ Komentarz jednowierszowy dla PHP
W przypadku komentarza jednowierszowego użyj znaków „//” lub „#”
Po tych znakach wszystko, co zostanie zapisane w jednej linii, zostanie zignorowane i potraktowane jako komentarz.
Subskrybuj, aby otrzymywać aktualizacje"; # subskrybuj (to jest komentarz) ?>
Zapisz się, aby zaktualizować
⇒ Komentarz wielowierszowy dla PHP
Komentarz wielowierszowy w PHP zaczyna się od „/*” i kończy na „*/”.
Wszystko pomiędzy tymi znakami będzie ignorowane i traktowane jako komentarz.
Jeśli wpis zawiera kilka wierszy, stosowany jest komentarz wielowierszowy.
Na ekranie zobaczysz tylko następujący tekst:
Witam czytelników bloga - strony !!!
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 ...
Spraw, aby przyszłość była dla Ciebie przyjemna - skomentuj kod, a wtedy powiesz sobie „DZIĘKUJĘ!!!”.
Zostaw komentarz w kodzie, zajmie Ci to 1 minutę, ale oszczędzi Ci to cały dzień w przyszłości.
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, lepiej to skomentuję. I nagle konieczne będzie zwrócenie kodu. Łatwiej odkomentować niż napisać kod w nowy sposób.
Jak skomentować kod wPHP
Przykład z komentarzem jednowierszowym:
Zapisz się, aby zaktualizować"; ?>
Przykład z komentarzem wielowierszowym.
