Kodeerimisel on kommentaarid üks väheseid viise, kuidas mõtteid tuleviku jaoks säilitada. Need aitavad teil koodilõike üle vaadata ja võivad olla abiks järgmisele arendajale, kes püüab mõista, mida te päevi varem kirjutasite. Kui kasutate Visual Studio koodi (VS Code), pole vaja iga kord väsimatult kommentaaride eraldajaid välja kirjutada. VS Code'il on sisseehitatud otsetee funktsioon, mis säästab sekundeid (ja isegi minuteid) teie ajast.
Kiire VS-koodi kommentaari otsetee
Neile, kellel on kiire, on siin teie kuldne pilet:
- Üherealiseks kommentaariks kasutage Windowsis või Linuxis klahvikombinatsiooni Ctrl + / või Macis Cmd + /.
,
- Blokeeritud kommentaariks kasutage Windowsis või Linuxis klahvikombinatsiooni Shift + Alt + A või Macis Shift + Option + A.
,
- Koodi kommenteerimiseks võite Windowsis vajutada Ctrl + K + C või Macis Cmd + K + U.
,
Enamik kodeerijaid kommenteerib palju. Ja see ei tähenda ainult tegelike kommentaaride jätmist, vaid võib-olla veelgi olulisem on see, et kommenteerite ja eemaldate koodi. Seda saab kasutada testimiseks, katsetamiseks ja silumiseks.
Selle meeldivamaks muutmiseks on olemas otseteed. Need kiirendavad navigeerimist ja muutmist, võimaldades teil kommentaare ümber lülitada ilma kodeerimiskiirust häirimata.
kuidas tulekahju lähtestada
Commenting Beyond the Basics
Kuigi põhilised otseteed on tõeline kingitus, on VS-koodi kommenteerimisel palju muudki. Süveneme sügavamale:
Kommentaaride sisse- ja väljalülitamine
VS Code'i kommentaaride otseteede parim osa on nende ümberlülitusfunktsioon. Kui muudate meelt (või silumise ajal), ei pea te iga kommentaarimarkeri kallal askeldama ega käsitsi eemaldama. Selle asemel kasutate samu otseteid. Samade klahvikombinatsioonidega saate kiiresti vahetada kommenteeritud ja kommenteerimata koodi vahel, et püsida korrastatuna, kui seda kõige rohkem vajate.
Mitme rea kommenteerimine
Kui teil on vaja vaigistada pikk koodiplokk või jätta ulatuslik ja üksikasjalik kommentaar, ei taha te kulutada aega vaevarikkalt kommentaaride rida-realt lisamisele. Selle asemel saate valida read, mida soovite desaktiveerida, ja kasutada kommentaaride otseteed, et lubada VS Code'il igale reale kommentaare lisada.
Pesastatud kommentaarid
Mõnikord võib kommentaaride sisestamine koodiplokki kaasa tuua ootamatuid tulemusi ja vigu, kui eraldajad ei ühti päris hästi. Siin saab teid aidata Visual Studio Code'i Intellisense. See kohandab kommentaaride vormingut teie eest isegi juba kommenteeritud plokis, nii et pesastatud kommentaaridega ei tekiks konflikte.
Supercharge kommenteerimise laiendused
VS Code on avatud lähtekoodiga redaktor, mis on platvormina arendajatele oma parima laiendustöö väljatöötamiseks. Turg on täis laiendusi, mis annavad teile kommenteerimisel rohkem jõudu ja kasulikkust:
kas saate andeka mängu eest raha tagasi maksta
Paremad kommentaarid
Kommenteerimine võib tunduda väikese ja valikulise kodeerimise osana, kuid kommentaaride kasutamiseks on nii palju loomingulisi viise. The Paremad kommentaarid laiendus aitab teil lisada kommentaaridele eesmärki ja selgust, liigitades need hoiatusteks, päringuteks, ülesanneteks ja muudeks kategooriateks. Ja seda kõike koos lisaboonuseks värvikoodiga, mis parandab nähtavust ja organiseeritust. Teie kommentaaridest saavad suunavad punktid ja eraldajad, mis muudavad teie koodi kenamaks ja ligipääsetavamaks.
Kommentaaride ankrud
Kommentaaride ankrud hoiab teid oma koodis maandatud täppidega, mis eristavad jaotisi või olulisi kohti. Kui proovite seda laiendust, võimaldab see kiiresti leida täpseid märkmeid ja märkusi. Kui teie projekt on suur ja teie kood on umbne ja raskesti jälgitav, võib see muuta selle palju paremini seeditavaks.
Poola kood
Poola kood muudab teie koodi ja kommentaarid visuaalselt huvitavateks, hõlpsasti loetavateks ja jagatavateks kujutisteks, mis sobivad ideaalselt sotsiaalmeediasse. See võimaldab teil muuta suurust, värvikoodi, muuta tausta ja palju muud. Saate paremast loetavusest kasu ning kõik meeskonnakaaslased saavad palju lihtsamalt koostööd teha ja teadmisi jagada.
Miks kommenteerida?
Kommenteerimine ei ole lihtsalt kast linnukese tegemiseks või mõni valikuline töö, mida sõnamurdjad teevad; see on kodeerimise lahutamatu osa. Siin on mõned selle põhjused.
Selgus
Kodeerijad püüavad muuta raskesti mõistetavaks. Töötava koodi kirjutamine võib mõnikord olla lihtsam kui hõlpsasti mõistetava ja järgitava koodi kirjutamine. Kommentaarid on arendaja kompass – hindamatu abivahend koodis navigeerimiseks, olgu need siis kerged ja noored või tihedad ja küpsed. Võimalik, et teil on tegemist keeruliste algoritmide või salapäraste äriprotsessidega. Igal juhul pakuvad kommentaarid keerukusemeres tuttavat käepidet.
Koostöö
Kommentaarid on kasulikud, kui olete üksi arendaja. Kuid need on vajalikud meeskonnana töötades, kui soovite, et teie projekt edeneks. Koostöös võimaldavad kommentaarid mitmel arendajal sujuvalt koostööd teha ka siis, kui nad ei suhtle. Meeskonnaliikmed saavad koodi selgitada ja jagada oma mõtteprotsesse ja otsuste põhjendusi. See toimib sillana, mis võimaldab kõigil olla nii projekti kui ka üksteisega ühel lehel.
Silumine
Kui avastate end vana koodi uuesti vaatamast või proovite siluda midagi, mis teid müstifitseerib, saavad kommentaarid teie päästmiseks. Nad salvestavad teie varasemat loogikat ja mõtlemisprotsessi, mis võib viidata võimalikule vigasele loogikale ja viia teid tagasi vea päritolu juurde. Selle meeldetuletusega selle kohta, kus olite minevikus, saate probleemsed muudatused tagasi võtta, vanemat koodi optimeerida ja õigele teele tagasi pöörduda.
Näpunäiteid tõhusaks kommenteerimiseks
Nüüd teate, kuidas kasutada kommentaaride otseteid, teil on mugavaid lisalaiendeid ja mõistate stsenaariume, millal kommenteerimine on kõige kasulikum. Teil jääb üle vaid kaaluda mõningaid kommenteerimise parimaid tavasid ja oletegi lõpetanud kommentaaride kodeerimise kursuse.
mitu USB porti lülitil
Olge lühidalt
Lühikeste, kergesti seeditavate kommentaaride mahajätmine on kunstiline. Jätke täpselt nii palju, et anda oma tulevasele minale või meeskonnaliikmetele õige idee, kuid mitte nii palju, et olla ülejõukäiv. Igal teie kommentaari sõnal peaks olema eesmärk ja see peaks aitama edasi arendada sõnumit, mida soovite edastada. Kui teie kommentaar on liiga lühike, ei pruugi see oma sõnumit edasi anda, kuid kui see on liiga pikk, on tõenäolisem, et libistate sellest tulevikus üle või lähete sellest segadusse.
Vältige ilmseid kommentaare
Asjakohasus peaks olema teie peamine mure selge ja arusaadava koodi loomisel. Kui juba kirjutad oma koodi nii, et selle tähendus oleks ilmne, pole vaja mainida midagi, mis esmapilgul näha on. Laske koodil igal võimalusel rääkida ja kasutage kommentaare, et lisada konteksti või pakkuda uusi vaatenurki.
Kasutage kommentaare 'Miks', mitte 'Mida' jaoks
Teie kood kirjeldab toimuva fakte. Kuid kommentaarid võivad rääkida sügavama loo. Need annavad edasi teie otsuste taga olevaid motiive ja mõtteprotsesse. Miks valisite selle algoritmi mõne teise asemel? Millised olid lõksud, mida meeles pidada? Võib-olla proovisite mõnda koodi, mida paljud soovitaksid, kuid see ei töötanud või ei toiminud hästi. Hästi koostatud kommentaaridega saate edastada palju enamat kui lihtsalt juhiseid.
Kommentaari jätmine
VS-koodi kommenteerimise funktsioon võib olla rohkem kui mugavus. Kui kasutate seda täielikult ära, võib teie koodibaasi navigeeritavuse ja arusaadavuse erinevus olla tohutu. Nutikate laiendustega ja põhjaliku strateegiaga saate peagi luua hästi dokumenteeritud koodi, mis loeb nagu meistriteos.
Kas jätate oma koodi selgitamiseks palju kommentaare? Või kasutate enamasti kommentaare selleks, et silurist välja jätta katkine või katseline kood? Rääkige meile oma lugu allolevates kommentaarides. Nad on siin selleks, et jääda.
