Kommenttipikakuvakkeen käyttäminen VS-koodissa

Koodauksessa kommentit ovat yksi harvoista tavoista säilyttää ajatuksia tulevaisuutta varten. Ne voivat auttaa sinua selvittämään koodinpätkät ja voivat olla hyödyllisiä seuraavalle kehittäjälle, joka yrittää ymmärtää kirjoittamaasi päivää aiemmin. Jos käytät Visual Studio Codea (VS Code), sinun ei tarvitse väsymättä kirjoittaa kommenttien erottimia joka kerta. VS Codessa on sisäänrakennettu pikakuvakeominaisuus, joka säästää sekunteja (ja jopa minuutteja) ajasta.

Pika VS-koodin kommenttipikakuvake

Niille, joilla on kiire, tässä on kultainen lippusi:

• Käytä yksirivistä kommenttia varten Ctrl + / -näppäinyhdistelmää Windowsissa tai Linuxissa tai Cmd + / Macissa.
  ,
• Jos haluat estää kommentin, käytä sen sijaan Vaihto + Alt + A Windowsissa tai Linuxissa tai Vaihto + Optio + A Macissa.
  ,
• Voit kommentoida koodia painamalla Ctrl + K + C Windowsissa tai Cmd + K + U Macissa.
  ,

Useimmat koodaajat kommentoivat paljon. Eikä kyse ole vain oikeiden kommenttien jättämisestä, vaan ehkä vielä tärkeämpää on, että kommentoit ja poistat kommentteja. Tämä on käyttökelpoinen testaamiseen, kokeiluun ja virheenkorjaukseen.

Pikanäppäimet tekevät tästä maukkaamman. Ne nopeuttavat navigointia ja muokkaamista, jolloin voit vaihtaa kommentteja häiritsemättä koodausnopeutta.

Commenting Beyond the Basics

Vaikka peruspikanäppäimet ovat todellinen lahja, VS-koodin kommentoimisessa on paljon muutakin. Otetaanpa syvemmälle:

Vaihda kommentit

Paras osa VS Coden kommenttipikanäppäimistä on niiden vaihtotoiminto. Sinun ei tarvitse pohtia ja poistaa jokaista kommenttimerkkiä manuaalisesti, jos muutat mieltäsi (tai virheenkorjauksen aikana). Sen sijaan käytät vain samoja pikanäppäimiä. Samoilla näppäinyhdistelmillä voit vaihtaa nopeasti kommentoidun ja kommentoimattoman koodin välillä pysyäksesi järjestyksessä, kun sitä eniten tarvitset.

Kommentoi useita rivejä

Jos haluat mykistää pitkän koodilohkon tai jättää laajan, yksityiskohtaisen kommentin, et halua käyttää aikaa vaivalloiseen kommenttien lisäämiseen rivi riviltä. Sen sijaan voit valita rivit, jotka haluat poistaa käytöstä, ja käyttää kommenttipikakuvaketta antaaksesi VS Coden lisätä kommentteja jokaiselle riville.

Sisäkkäiset kommentit

Joskus kommenttien lisääminen koodilohkoon voi johtaa odottamattomiin tuloksiin ja virheisiin, jos erottimet eivät täsmää oikein hyvin. Tässä Visual Studio Coden Intellisense voi auttaa sinua. Se säätää kommenttien muotoilua puolestasi jopa jo kommentoidun lohkon sisällä, joten sisäkkäisten kommenttien kanssa ei synny ristiriitoja.

Laajennukset Supercharge-kommentointiin

VS Code on avoimen lähdekoodin editori, joka toimii alustana kehittäjille, jotka voivat tehdä parhaan laajennustyönsä. Markkinat ovat täynnä laajennuksia, jotka antavat sinulle enemmän tehoa ja hyödyllisyyttä kommentoiessasi:

Parempia kommentteja

Kommentointi saattaa tuntua pieneltä ja valinnaiselta osalta koodausta, mutta kommenttien käyttämiseen on monia luovia tapoja. Paremmat kommentit -laajennus auttaa sinua lisäämään tarkoitusta ja selkeyttä kommentteihisi luokittelemalla ne hälytyksiin, kyselyihin, TODOihin ja muihin luokkiin. Ja siinä kaikki lisäetuna värikoodauksella, joka parantaa näkyvyyttä ja organisointia. Kommenteistasi tulee ohjaavia kohtia ja erottimia, jotka tekevät koodistasi siistimmän ja helposti lähestyttävämmän.

Kommenttiankkurit

Kommenttiankkurit pitävät sinut pohjassa koodissasi pisteillä, jotka erottavat osiot tai olennaiset kohdat. Jos kokeilet tätä laajennusta, löydät sen avulla nopeasti tarkat huomautukset ja huomautukset. Jos projektisi on laaja ja koodisi on täynnä ja vaikeasti seurattavaa, tämä saattaa tehdä siitä paljon sulavamman.

Polacode

Polacode muuttaa koodisi ja kommenttisi visuaalisesti mielenkiintoisiksi, helposti luettaviksi ja jaettavissa oleviksi kuviksi, jotka sopivat täydellisesti sosiaaliseen mediaan. Sen avulla voit muuttaa kokoa, värikoodeja, vaihtaa taustaa ja paljon muuta. Hyödyt paremmasta luettavuudesta, ja kaikki tiimitoverit voivat tehdä yhteistyötä ja jakaa oivalluksia paljon helpommin.

Miksi kommentoida?

Kommentointi ei ole vain valintaruutu tai valinnainen askare, jota sanalliset ihmiset tekevät; se on olennainen osa koodausta. Tässä on joitain syitä siihen:

Selkeys

Koodaajat pyrkivät tekemään vaikeaselkoisesta ymmärrettäväksi. Toimivan koodin kirjoittaminen voi joskus olla yksinkertaisempaa kuin helposti ymmärrettävän ja seurattavan koodin kirjoittaminen. Kommentit ovat kehittäjän kompassi – korvaamaton apu koodin laajuudessa navigoinnissa, olivatpa ne kevyitä ja nuoria tai tiheitä ja kypsiä. Saatat olla tekemisissä monimutkaisten algoritmien tai vaikeaselkoisten liiketoimintaprosessien kanssa. Joka tapauksessa kommentit tarjoavat tutun kädensijan monimutkaisuuden meressä.

Yhteistyö

Kommentit ovat käteviä, kun olet yksin kehittäjä. Mutta ne ovat välttämättömiä työskennellessäsi tiiminä, jos haluat projektisi edistyvän. Kommenttien ansiosta useat kehittäjät voivat työskennellä saumattomasti yhdessä, vaikka ne eivät olisikaan vuorovaikutuksessa. Tiimin jäsenet saavat selittää koodin ja jakaa ajatusprosessinsa ja perustelunsa päätöstensä taustalla. Tämä toimii siltana, jonka avulla kaikki voivat olla samalla sivulla sekä projektin että toistensa kanssa.

Virheenkorjaus

Jos huomaat palaamassa vanhaan koodiin tai yrittävän korjata jotain, joka hämmentää sinua, kommenteista tulee pelastava armosi. He pitävät kirjaa menneestä logiikastasi ja ajatteluprosessistasi, mikä voi osoittaa sinut mahdolliseen virheelliseen logiikkaan ja saattaa johtaa sinut takaisin vian alkuperään. Tällä muistutuksella siitä, missä olit menneisyydessä, voit peruuttaa ongelmalliset muutokset, optimoida vanhan koodin ja palata raiteilleen.

Vinkkejä tehokkaaseen kommentoimiseen

Nyt tiedät kuinka käyttää kommenttipikakuvakkeita, sinulla on käteviä lisälaajennuksia ja ymmärrät skenaariot, kun kommentoiminen on hyödyllisintä. Sinun tarvitsee vain harkita kommentoinnin parhaita käytäntöjä, ja olet valmistunut koodauskommenttien kurssista.

Ole ytimekäs

On taiteellista jättää taakseen ytimekkäitä, helposti sulavia kommentteja. Jätä vain tarpeeksi antaaksesi tulevaisuuden itsellesi tai tiimisi jäsenille oikean idean, mutta ei niin paljon, jotta se olisi ylivoimainen. Jokaisella kommenttisi sanalla tulee olla tarkoitus ja auttaa rakentamaan viestiä, jota yrität välittää. Jos kommenttisi on liian lyhyt, se ei välttämättä välitä viestiään, mutta jos se on liian pitkä, ohitat sen todennäköisemmin tai tulet hämmentymään siitä tulevaisuudessa.

Vältä ilmeisiä kommentteja

Osuvuuden tulisi olla ensisijainen huolenaihe selkeän ja ymmärrettävän koodin luomisessa. Jos kirjoitat koodisi jo niin, että sen merkitys on ilmeinen, ei tarvitse mainita mitään, mikä näkyy ensi silmäyksellä. Anna koodin puhua aina kun se voi ja käytä kommentteja lisätäksesi kontekstia tai tarjotaksesi uusia näkökulmia.

Käytä kommentteja "miksi", älä "mitä"

Koodisi paljastaa tosiasiat siitä, mitä tapahtuu. Mutta kommentit voivat kertoa syvemmän tarinan. Ne välittävät päätöstesi takana olevat motivaatiot ja ajatusprosessit. Miksi valitsit tämän algoritmin toisen sijaan? Mitä sudenkuoppia oli pidettävä mielessä? Ehkä kokeilit jotain koodia, jota monet suosittelevat, mutta se ei toiminut tai toiminut huonosti. Hyvin muotoilluilla kommenteilla voit välittää paljon enemmän kuin pelkät ohjeet.

Kommentin jättäminen

VS-koodin kommentointiominaisuus voisi olla enemmän kuin kätevä. Jos hyödynnät sitä täyden hyödyn, ero koodikantasi navigoitavuudessa ja ymmärrettävyydessä voi olla valtava. Älykkäillä laajennuksilla ja perusteellisella strategialla täydennettynä voit pian luoda hyvin dokumentoitua koodia, joka lukee kuin mestariteos.

Jätätkö paljon kommentteja selittääksesi koodisi? Vai käytätkö enimmäkseen kommentteja poistaaksesi viallisen tai kokeellisen koodin virheenkorjausohjelmasta? Kerro meille tarinasi alla olevissa kommenteissa. He ovat täällä jäädäkseen.