Slik bruker du kommentarsnarveien i VS-kode

I koding er kommentarer en av få måter å bevare tanker for fremtiden. De kan hjelpe deg med å få oversikt over kodebiter og kan være nyttige for den neste utvikleren som skal prøve å forstå hva du skrev dager før. Hvis du bruker Visual Studio Code (VS Code), er det ikke nødvendig å utrettelig skrive ut kommentaravgrensere hver gang. VS Code har en innebygd snarveisfunksjon som sparer sekunder (og til og med minutter) av tiden din.

Hurtig-VS-kodekommentarsnarveien

For de som har det travelt, her er din gyldne billett:

• For en enkeltlinjekommentar, bruk Ctrl + / tastekombinasjonen på Windows eller Linux eller Cmd + / på en Mac.
  ,
• For en blokkkommentar, bruk Shift + Alt + A på Windows eller Linux eller Shift + Tilvalg + A på en Mac i stedet.
  ,
• For å kommentere kode, kan du trykke Ctrl + K + C på Windows eller Cmd + K + U på Mac.
  ,

De fleste kodere kommenterer mye. Og det handler ikke bare om å legge igjen faktiske kommentarer, men kanskje enda viktigere, du vil kommentere ut og avkommentere kode. Dette er levedyktig for testing, eksperimentering og feilsøking.

Snarveier er der for å gjøre dette mer velsmakende. De fremskynder navigering og endring, slik at du kan veksle mellom kommentarer uten å forstyrre kodingen.

Kommentering utover det grunnleggende

Selv om de grunnleggende snarveiene er en ekte gave, er det så mye mer å kommentere VS-kode. La oss gå dypere:

Slå på kommentarer

Det beste med VS Code-kommentarsnarveiene er vekslefunksjonen deres. Du trenger ikke å fikle og fjerne hver kommentarmarkør manuelt hvis du ombestemmer deg (eller under feilsøking). I stedet bruker du bare de samme snarveiene. Med de samme tastekombinasjonene kan du raskt bytte mellom kommentert og ikke-kommentert kode for å holde deg organisert når du trenger det mest.

Kommenter flere linjer

Hvis du trenger å dempe en lang kodeblokk eller legge igjen en omfattende, detaljert kommentar, vil du ikke bruke tid på å legge til kommentarer linje for linje. Så i stedet kan du velge linjene du vil deaktivere og bruke kommentarsnarveien for å la VS-kode sette inn kommentarer i hver linje.

Nestede kommentarer

Noen ganger kan det å sette inn kommentarer i en kodeblokk føre til uventede resultater og feil hvis skilletegnene ikke stemmer godt overens. Det er her Visual Studio Codes Intellisense kan hjelpe deg. Den vil justere kommentarformateringen for deg selv innenfor en allerede kommentert blokk, slik at det ikke vil være konflikter med nestede kommentarer.

Utvidelser til Supercharge Commenting

VS Code er en åpen kildekode-editor som fungerer som en plattform for utviklere for å legge ut sitt beste utvidelsesarbeid. Markedsplassen er full av utvidelser for å gi deg mer kraft og nytte når du kommenterer:

Bedre kommentarer

Å kommentere kan virke som en liten og valgfri del av koding, men det er så mange kreative måter å bruke kommentarer på. Better Comments- utvidelsen hjelper deg å legge til formål og klarhet til kommentarene du strø om ved å kategorisere dem i varsler, spørringer, TODO-er og andre kategorier. Og det er alt med den ekstra bonusen med fargekoding for forbedret synlighet og organisering. Kommentarene dine blir veiledende punkter og skilletegn som gjør koden din ryddigere og mer tilgjengelig.

Kommentar Ankere

Kommentarankre holder deg jordet i koden din med punkter som skiller seksjoner eller viktige steder innenfor. Hvis du prøver denne utvidelsen, lar den deg raskt finne presise notater og bemerkninger. Hvis prosjektet ditt er stort og koden din blir stappfull og vanskelig å følge, kan dette gjøre det mye mer fordøyelig.

Polacode

Polacode forvandler koden og kommentarene dine til visuelt interessante, lett lesbare, delbare bilder som er perfekte for sosiale medier. Den lar deg endre størrelse, fargekode, endre bakgrunnen og mer. Du drar nytte av større lesbarhet, og alle lagkamerater kan samarbeide og dele innsikt mye enklere.

Hvorfor kommentere?

Å kommentere er ikke bare en boks å krysse av eller et valgfritt arbeid som ordrike mennesker gjør; det er en integrert del av koding. Her er noen av årsakene til det:

Klarhet

Kodere søker å gjøre det vanskelige forståelig. Å skrive kode som fungerer kan noen ganger være enklere enn å skrive kode som er lett å forstå og følge. Kommentarer er en utviklers kompass – en uvurderlig hjelp til å navigere i store områder med kode, enten de er lette og unge eller tette og modne. Du har kanskje å gjøre med kronglete algoritmer eller mystiske forretningsprosesser. Uansett gir kommentarer et kjent håndtak i et hav av kompleksitet.

Samarbeid

Kommentarer er nyttige når du er en soloutvikler. Men de er nødvendige når du jobber som et team hvis du ønsker at prosjektet ditt gjør fremskritt. Innenfor en samarbeidsinnsats lar kommentarer flere utviklere sømløst jobbe sammen selv når de ikke samhandler. Teammedlemmer får forklare koden og dele sine tankeprosesser og resonnementer bak beslutningene sine. Dette fungerer som en bro som lar alle være på samme side med både prosjektet og hverandre.

Feilsøking

Hvis du finner deg selv å gå tilbake til gammel kode eller prøver å feilsøke noe som forvirrer deg, blir kommentarer din frelsende nåde. De fører en oversikt over din tidligere logikk og tankeprosess som kan vise deg den mulige feil logikken og kan føre deg tilbake til feilens opprinnelse. Med denne påminnelsen om hvor du hadde vært tidligere, kan du tilbakestille problematiske endringer, optimalisere eldre kode og komme tilbake på sporet.

Tips for effektiv kommentering

Nå vet du hvordan du bruker kommentarsnarveiene, har noen praktiske tilleggsutvidelser og forstår scenarier når det er mest nyttig å kommentere. Alt du har igjen er å vurdere noen beste fremgangsmåter for kommentering, og du vil ha uteksaminert fra kurset om koding av kommentarer.

Vær konsis

Det er kunstnerskap i å etterlate seg konsise, lettfordøyelige kommentarer. Legg igjen akkurat nok til å gi ditt fremtidige jeg eller teammedlemmene dine den rette ideen, men ikke så mye for å være overveldende. Hvert ord i kommentaren din bør ha en hensikt og bidra til å bygge videre på budskapet du prøver å formidle. Hvis kommentaren din er for kort, kan den mislykkes i å formidle budskapet, men hvis den er for lang, er det mer sannsynlig at du skumles over eller blir forvirret av den i fremtiden.

Unngå åpenbare kommentarer

Relevans bør være din primære bekymring for å lage klar og forståelig kode. Hvis du allerede skriver koden din slik at betydningen er åpenbar, er det ikke nødvendig å nevne noe som kan sees ved første øyekast. La koden snakke når den kan, og bruk kommentarer for å legge til ekstra kontekst eller gi nye perspektiver.

Bruk kommentarer for "Hvorfor", ikke "Hva"

Koden din legger ut fakta om hva som skjer. Men kommentarer kan fortelle en dypere historie. De formidler motivasjonene og tankeprosessene bak beslutningene dine. Hvorfor valgte du denne algoritmen fremfor en annen? Hva var fallgruvene å huske på? Kanskje du prøvde en kode mange ville anbefale, men den fungerte ikke eller fungerte dårlig. Du kan formidle så mye mer enn bare instruksjoner med godt utformede kommentarer.

Legger igjen en kommentar

VS-kode-kommentarfunksjonen kan være mer enn en bekvemmelighet. Hvis du drar full nytte av det, kan forskjellen i navigerbarheten og forståeligheten til kodebasen din være enorm. Supplert med smarte utvidelser og en grundig strategi, kan du snart lage godt dokumentert kode som kan leses som et mesterverk.

Legger du igjen mange kommentarer for å forklare koden din? Eller bruker du mest kommentarer for å ekskludere ødelagt eller eksperimentell kode fra feilsøkeren? Fortell oss din historie i kommentarfeltet nedenfor. De er kommet for å bli.