Hur man använder kommentargenvägen i VS-kod

I kodning är kommentarer ett av få sätt att bevara tankar för framtiden. De kan hjälpa dig att överblicka kodavsnitt och kan vara till hjälp för nästa utvecklare som kommer att försöka förstå vad du skrev dagar innan. Om du använder Visual Studio Code (VS Code), finns det ingen anledning att outtröttligt skriva ut kommentaravgränsare varje gång. VS Code har en inbyggd genvägsfunktion som sparar sekunder (och till och med minuter) av din tid.

Genvägen Quick VS Code Comment

För de som har bråttom, här är din gyllene biljett:

• För en enradskommentar, använd tangentkombinationen Ctrl + / på Windows eller Linux eller Cmd + / på en Mac.
  ,
• För en blockkommentar, använd Shift + Alt + A på Windows eller Linux eller Shift + Option + A på en Mac istället.
  ,
• För att kommentera kod kan du trycka på Ctrl + K + C på Windows eller Cmd + K + U på Mac.
  ,

De flesta kodare kommenterar mycket. Och det handlar inte bara om att lämna faktiska kommentarer, utan kanske ännu viktigare, du kommer att kommentera och avkommentera kod. Detta är genomförbart för testning, experimentering och felsökning.

Genvägar finns för att göra detta mer tilltalande. De påskyndar navigering och ändring, vilket gör att du kan växla kommentarer utan att störa kodningsmomentet.

Kommentera bortom grunderna

Även om de grundläggande genvägarna är en riktig gåva, finns det så mycket mer att kommentera VS Code. Låt oss gräva djupare:

Växla kommentarer

Det bästa med VS Code-kommentargenvägarna är deras växlingsfunktion. Du behöver inte pilla och ta bort varje kommentarsmarkör manuellt om du ändrar dig (eller under felsökning). Istället använder du bara samma genvägar. Med samma tangentkombinationer kan du snabbt växla mellan kommenterad och okommenterad kod för att hålla dig organiserad när du behöver det som mest.

Kommentera flera rader

Om du behöver stänga av ett långt kodblock eller lämna en omfattande, detaljerad kommentar, vill du inte lägga tid på att lägga till kommentarer rad för rad. Så istället kan du välja de rader du vill inaktivera och använda kommentargenvägen för att låta VS Code infoga kommentarer i varje rad.

Kapslade kommentarer

Ibland kan att infoga kommentarer i ett kodblock leda till oväntade resultat och fel om avgränsningarna inte matchar riktigt bra. Det är här Visual Studio Codes Intellisense kan hjälpa dig. Det kommer att justera kommentarsformateringen för dig även inom ett redan kommenterat block, så att det inte kommer att uppstå konflikter med kapslade kommentarer.

Tillägg till Supercharge Commenting

VS Code är en öppen källkodsredigerare som fungerar som en plattform för utvecklare att lägga ut sitt bästa förlängningsarbete. Marknaden är full av tillägg för att ge dig mer kraft och nytta när du kommenterar:

Bättre kommentarer

Att kommentera kan verka som en liten och valfri del av kodning, men det finns så många kreativa sätt att använda kommentarer. Tillägget Better Comments hjälper dig att lägga till syfte och klarhet till kommentarerna du sprider om genom att kategorisera dem i varningar, frågor, TODOs och andra kategorier. Och det är allt med den extra bonusen med färgkodning för förbättrad synlighet och organisation. Dina kommentarer blir vägledande punkter och separatorer som gör din kod snyggare och mer lättillgänglig.

Kommentar Anchors

Kommentar Ankare håller dig jordad i din kod med punkter som särskiljer sektioner eller viktiga punkter inom. Om du provar det här tillägget låter det dig snabbt hitta exakta anteckningar och kommentarer. Om ditt projekt är stort och din kod blir fullproppad och svår att följa, kan detta göra det mycket mer lättsmält.

Polacode

Polacode förvandlar din kod och dina kommentarer till visuellt intressanta, lättläsliga, delbara bilder som är perfekta för sociala medier. Det låter dig ändra storlek, färgkoda, ändra bakgrunden och mer. Du drar nytta av större läsbarhet och alla lagkamrater kan samarbeta och dela insikter mycket enklare.

Varför kommentera?

Att kommentera är inte bara en ruta att markera eller någon valfri syssla som ordrika människor gör; det är en integrerad del av kodning. Här är några av anledningarna till det:

Klarhet

Kodare försöker göra det svårlösta begripligt. Att skriva kod som fungerar kan ibland vara enklare än att skriva kod som är lätt att förstå och följa. Kommentarer är en utvecklares kompass – ett ovärderligt hjälpmedel för att navigera i kodvidder, vare sig de är lätta och unga eller täta och mogna. Du kanske har att göra med invecklade algoritmer eller mystiska affärsprocesser. Hur som helst ger kommentarer ett välbekant handtag i ett hav av komplexitet.

Samarbete

Kommentarer är praktiska när du är en solo-utvecklare. Men de är nödvändiga när du arbetar som ett team om du vill att ditt projekt ska göra några framsteg. Inom ett samarbete låter kommentarer flera utvecklare sömlöst arbeta tillsammans även när de inte interagerar. Teammedlemmar får förklara koden och dela sina tankeprocesser och resonemang bakom sina beslut. Detta fungerar som en bro som gör att alla kan vara på samma sida med både projektet och varandra.

Felsökning

Om du hittar på att du återvänder till gammal kod eller försöker felsöka något som gör dig mystifierad, blir kommentarer din räddning. De håller ett register över din tidigare logik och tankeprocess som kan peka dig till den eventuella felaktiga logiken och kan leda dig tillbaka till felets ursprung. Med den här påminnelsen om var du hade varit tidigare kan du återställa problematiska ändringar, optimera äldre kod och komma tillbaka på rätt spår.

Tips för effektiv kommentering

Nu vet du hur du använder kommentarsgenvägarna, har några praktiska ytterligare tillägg och förstår scenarier när det är mest användbart att kommentera. Allt du har kvar är att överväga några bästa metoder för att kommentera, och du kommer att ha tagit examen från kursen för kodning av kommentarer.

Var kortfattad

Det ligger konstnärlighet i att lämna efter sig kortfattade, lättsmälta kommentarer. Lämna in precis tillräckligt för att ge ditt framtida jag eller dina teammedlemmar rätt idé, men inte så mycket för att vara överväldigande. Varje ord i din kommentar bör ha ett syfte och hjälpa till att bygga vidare på det budskap du försöker förmedla. Om din kommentar är för kort kan den misslyckas med att förmedla sitt budskap, men om den är för lång är det mer sannolikt att du skummar över eller blir förvirrad av den i framtiden.

Undvik uppenbara kommentarer

Relevans bör vara din primära uppgift när det gäller att skapa tydlig och begriplig kod. Om du redan skriver din kod så att dess innebörd är uppenbar behöver du inte nämna något som kan ses vid första anblicken. Låt koden tala när den kan och använd kommentarer för att lägga till extra sammanhang eller ge nya perspektiv.

Använd kommentarer för "Varför", inte "Vad"

Din kod anger fakta om vad som händer. Men kommentarer kan berätta en djupare historia. De förmedlar motivationerna och tankeprocesserna bakom dina beslut. Varför valde du den här algoritmen framför en annan? Vilka var fallgroparna att tänka på? Du kanske provade någon kod som många skulle rekommendera, men den fungerade inte eller fungerade inte bra. Du kan förmedla så mycket mer än bara instruktioner med välarbetade kommentarer.

Lämna en kommentar

VS Code-kommentarfunktionen kan vara mer än en bekvämlighet. Om du drar full nytta av det kan skillnaden i navigeringsförmåga och förståelighet för din kodbas vara enorm. Kompletterat med smarta tillägg och en noggrann strategi kan du snart skapa väldokumenterad kod som läser som ett mästerverk.

Lämnar du många kommentarer för att förklara din kod? Eller använder du mest kommentarer för att utesluta trasig eller experimentell kod från felsökaren? Berätta för oss din historia i kommentarerna nedan. De är här för att stanna.