Jak korzystać ze skrótu komentarza w kodzie VS

W kodowaniu komentarze są jednym z niewielu sposobów zachowania myśli na przyszłość. Mogą pomóc w przejrzeniu fragmentów kodu i mogą być pomocne dla następnego programisty, który będzie próbował zrozumieć to, co napisałeś kilka dni wcześniej. Jeśli używasz Visual Studio Code (VS Code), nie ma potrzeby niestrudzonego wpisywania za każdym razem ograniczników komentarzy. VS Code ma wbudowaną funkcję skrótu, która oszczędza sekundy (a nawet minuty) Twojego czasu.

Skrót komentarza szybkiego kodu VS

Dla tych, którym się spieszy, oto Twój złoty bilet:

• Aby dodać komentarz jednowierszowy, użyj kombinacji klawiszy Ctrl + / w systemie Windows lub Linux albo Cmd + / na komputerze Mac.
  ,
• Aby utworzyć komentarz blokowy, użyj zamiast tego Shift + Alt + A w systemie Windows lub Linux lub Shift + Opcja + A na komputerze Mac.
  ,
• Aby skomentować kod, możesz nacisnąć Ctrl + K + C w systemie Windows lub Cmd + K + U na komputerze Mac.
  ,

Większość programistów dużo komentuje. I nie chodzi tu tylko o pozostawienie faktycznych komentarzy, ale co ważniejsze, będziesz komentować i odkomentowywać kod. Jest to opłacalne do testowania, eksperymentowania i debugowania.

Istnieją skróty, dzięki którym jest to bardziej smaczne. Przyspieszają nawigację i wprowadzanie zmian, umożliwiając przełączanie komentarzy bez zakłócania tempa kodowania.

Komentowanie wykraczające poza podstawy

Choć podstawowe skróty to prawdziwy prezent, komentowanie VS Code to o wiele więcej. Zagłębmy się głębiej:

Przełącz komentarze

Najlepszą częścią skrótów komentarzy VS Code jest ich funkcja przełączania. Nie musisz ręcznie bawić się i usuwać każdego znacznika komentarza, jeśli zmienisz zdanie (lub podczas debugowania). Zamiast tego używasz tych samych skrótów. Dzięki tym samym kombinacjom klawiszy możesz szybko przełączać się między kodem skomentowanym i niekomentowanym, aby zachować porządek, gdy tego najbardziej potrzebujesz.

Komentowanie wielu linii

Jeśli chcesz wyciszyć długi blok kodu lub zostawić obszerny, szczegółowy komentarz, nie chcesz tracić czasu na żmudne dodawanie komentarzy wiersz po wierszu. Zamiast tego możesz wybrać linie, które chcesz dezaktywować, i użyć skrótu komentarza, aby umożliwić VS Code wstawianie komentarzy do każdej linii.

Zagnieżdżone komentarze

Czasami wstawianie komentarzy do bloku kodu może prowadzić do nieoczekiwanych wyników i błędów, jeśli ograniczniki nie pasują do siebie zbyt dobrze. W tym miejscu może Ci pomóc technologia Intellisense programu Visual Studio Code. Dostosuje dla Ciebie formatowanie komentarza nawet w obrębie już skomentowanego bloku, więc nie będzie konfliktów z zagnieżdżonymi komentarzami.

jak uzyskać nieaktywną nazwę użytkownika na Instagramie?

Rozszerzenia do komentowania Supercharge

VS Code to edytor typu open source, służący jako platforma dla programistów, na której mogą publikować najlepsze rozszerzenia. Rynek jest pełen rozszerzeń, które zapewniają większą moc i użyteczność podczas komentowania:

Lepsze komentarze

Komentowanie może wydawać się niewielką i opcjonalną częścią kodowania, ale istnieje wiele kreatywnych sposobów wykorzystania komentarzy. The Lepsze komentarze Rozszerzenie pomaga dodać cel i przejrzystość komentarzom, które posypujesz, kategoryzując je na alerty, zapytania, zadania do zrobienia i inne kategorie. A to wszystko z dodatkowym bonusem w postaci kodowania kolorami dla lepszej widoczności i organizacji. Twoje komentarze stają się punktami przewodnimi i separatorami, dzięki którym Twój kod jest bardziej przejrzysty i przystępny.

Kotwice komentarzy

Kotwice komentarzy ugruntuj swoją wiedzę w kodzie dzięki punktom odróżniającym sekcje lub istotne miejsca w obrębie kodu. Jeśli wypróbujesz to rozszerzenie, pozwoli Ci ono szybko znaleźć dokładne notatki i uwagi. Jeśli Twój projekt jest rozległy, a kod staje się przepełniony i trudny do zrozumienia, może to sprawić, że będzie on znacznie łatwiejszy do zrozumienia.

polski kod

polski kod przekształca Twój kod i komentarze w interesujące wizualnie, łatwe do odczytania i udostępniania obrazy, które idealnie nadają się do mediów społecznościowych. Umożliwia zmianę rozmiaru, kodowanie kolorami, zmianę tła i wiele więcej. Korzystasz z większej czytelności, a wszyscy członkowie zespołu mogą znacznie łatwiej współpracować i dzielić się spostrzeżeniami.

Dlaczego komentować?

Komentowanie to nie tylko pole do zaznaczenia lub opcjonalna czynność wykonywana przez rozwlekłych ludzi; to integralna część kodowania. Oto niektóre z powodów:

Przejrzystość

Koderzy starają się uczynić to, co trudne, zrozumiałym. Pisanie kodu, który działa, może czasami być prostsze niż pisanie kodu, który jest łatwy do zrozumienia i naśladowania. Komentarze są kompasem programisty – nieocenioną pomocą w poruszaniu się po obszarach kodu, niezależnie od tego, czy są lekkie i młode, czy gęste i dojrzałe. Być może masz do czynienia ze skomplikowanymi algorytmami lub tajemniczymi procesami biznesowymi. W każdym razie komentarze zapewniają znajomy punkt odniesienia w morzu złożoności.

Współpraca

Komentarze są przydatne, gdy jesteś programistą solo. Są one jednak niezbędne podczas pracy zespołowej, jeśli chcesz, aby Twój projekt poczynił postępy. Dzięki wspólnemu wysiłkowi komentarze umożliwiają wielu programistom bezproblemową współpracę, nawet gdy nie wchodzą w interakcję. Członkowie zespołu mogą wyjaśnić kod i podzielić się swoimi procesami myślowymi i uzasadnieniem swoich decyzji. Służy to jako pomost, dzięki któremu wszyscy mogą być na tej samej stronie zarówno w przypadku projektu, jak i siebie nawzajem.

Debugowanie

Jeśli zauważysz, że ponownie odwiedzasz stary kod lub próbujesz debugować coś, co Cię zaskakuje, komentarze staną się Twoim zbawieniem. Rejestrują Twoją przeszłą logikę i proces myślowy, co może wskazać Ci możliwą błędną logikę i doprowadzić Cię z powrotem do początków błędu. Dzięki temu przypomnieniu o tym, gdzie byłeś w przeszłości, możesz cofnąć problematyczne zmiany, zoptymalizować starszy kod i wrócić na właściwe tory.

Wskazówki dotyczące skutecznego komentowania

Teraz wiesz, jak korzystać ze skrótów komentarzy, masz kilka wygodnych dodatkowych rozszerzeń i rozumiesz scenariusze, w których komentowanie jest najbardziej przydatne. Pozostało Ci już tylko rozważyć kilka najlepszych praktyk w zakresie komentowania i ukończysz kurs kodowania komentarzy.

Bądź zwięzły

Pozostawianie zwięzłych, łatwo przyswajalnych komentarzy wiąże się z artyzmem. Zostaw tyle, aby dać sobie lub członkom zespołu właściwy pomysł, ale nie na tyle, aby było to przytłaczające. Każde słowo Twojego komentarza powinno mieć cel i pomóc w budowaniu wiadomości, którą próbujesz przekazać. Jeśli Twój komentarz jest zbyt krótki, może nie przekazać swojego przesłania, ale jeśli jest zbyt długi, istnieje większe prawdopodobieństwo, że w przyszłości go przejrzysz lub będziesz się przez niego dezorientować.

czy możesz kupić skórki w Overwatch?

Unikaj oczywistych komentarzy

Trafność powinna być główną troską przy tworzeniu jasnego i zrozumiałego kodu. Jeśli już piszesz swój kod tak, aby jego znaczenie było oczywiste, nie ma potrzeby wspominać o czymś, co widać na pierwszy rzut oka. Pozwól, aby kod mówił, kiedy tylko może, i używaj komentarzy, aby dodać dodatkowy kontekst lub zapewnić nowe perspektywy.

Używaj komentarzy do „Dlaczego”, a nie „Co”

Twój kod przedstawia fakty dotyczące tego, co się dzieje. Ale komentarze mogą opowiedzieć głębszą historię. Przekazują motywacje i procesy myślowe stojące za Twoimi decyzjami. Dlaczego wybrałeś ten algorytm, a nie inny? O jakich pułapkach warto pamiętać? Być może wypróbowałeś kod, który wielu poleciłoby, ale nie zadziałał lub nie działał dobrze. Dzięki dobrze przygotowanym komentarzom możesz przekazać znacznie więcej niż tylko instrukcje.

Pozostawienie komentarza

Funkcja komentowania VS Code może być czymś więcej niż wygodą. Jeśli w pełni go wykorzystasz, różnica w nawigacji i zrozumiałości bazy kodu może być ogromna. Uzupełniony sprytnymi rozszerzeniami i dokładną strategią, możesz wkrótce stworzyć dobrze udokumentowany kod, który czyta się jak arcydzieło.

Czy zostawiasz wiele komentarzy wyjaśniających swój kod? A może najczęściej używasz komentarzy, aby wykluczyć uszkodzony lub eksperymentalny kod z debugera? Opowiedz nam swoją historię w komentarzach poniżej. Oni tu zostaną.