Hvernig á að nota athugasemdarflýtileiðina í VS kóða

Í kóðun eru athugasemdir ein af fáum leiðum til að varðveita hugsanir til framtíðar. Þeir geta hjálpað þér að gljáa yfir kóðabúta og geta verið gagnlegar fyrir næsta forritara sem mun reyna að skilja það sem þú skrifaðir dögum áður. Ef þú ert að nota Visual Studio Code (VS Code), þá er engin þörf á að slá inn athugasemdaafmörk í hvert skipti. VS Code er með innbyggðan flýtileið sem sparar sekúndur (og jafnvel mínútur) af tíma þínum.

The Quick VS Code Comment Flýtileið

Fyrir þá sem eru að flýta sér, hér er gullni miðinn þinn:

• Fyrir einlínu athugasemd, notaðu Ctrl + / lyklasamsetninguna á Windows eða Linux eða Cmd + / á Mac.
  ,
• Fyrir blokk athugasemd, notaðu Shift + Alt + A á Windows eða Linux eða Shift + Valkostur + A á Mac í staðinn.
  ,
• Til að skrifa athugasemd við kóðann geturðu ýtt á Ctrl + K + C á Windows eða Cmd + K + U á Mac.
  ,

Flestir kóðarar tjá sig mikið. Og það snýst ekki bara um að skilja eftir raunverulegar athugasemdir, heldur kannski mikilvægara, þú munt skrifa athugasemdir og hætta að skrifa athugasemdir við kóða. Þetta er raunhæft til að prófa, gera tilraunir og villuleit.

Flýtileiðir eru til staðar til að gera þetta girnilegra. Þeir flýta fyrir siglingum og breytingum, sem gerir þér kleift að skipta um athugasemdir án þess að trufla skriðþunga kóðunar.

Athugasemdir Beyond the Basics

Þó að grunnflýtivísarnir séu algjör gjöf, þá er svo miklu meira við að tjá sig um VS kóða. Við skulum kafa dýpra:

Skiptu um athugasemdir

Það besta við VS Code athugasemdarflýtivísana er skiptaeiginleiki þeirra. Þú þarft ekki að fikta og fjarlægja hvert athugasemdamerki handvirkt ef þú skiptir um skoðun (eða meðan á villuleit stendur). Í staðinn notarðu bara sömu flýtivísana. Með sömu takkasamsetningum færðu fljótt að skipta á milli kóða sem hefur verið skrifaður og án athugasemda til að halda skipulagi þegar þú þarft mest á honum að halda.

Athugasemdir margar línur

Ef þú þarft að slökkva á langri kóðablokk eða skilja eftir víðtæka og nákvæma athugasemd, vilt þú ekki eyða tíma í að bæta við athugasemdum línu fyrir línu. Svo í staðinn geturðu valið línurnar sem þú vilt slökkva á og notað athugasemda flýtileiðina til að láta VS kóða setja athugasemdir inn í hverja línu.

Hreiður athugasemdir

Stundum getur það að setja athugasemdir inn í kóðablokk leitt til óvæntra niðurstaðna og villna ef afmörkunin passa ekki vel saman. Þetta er þar sem Intellisense frá Visual Studio Code getur hjálpað þér. Það mun stilla athugasemdasniðið fyrir þig jafnvel innan blokkar sem þegar hefur verið skrifað um athugasemdir, svo það verða ekki árekstrar við hreiður athugasemd.

Viðbætur við Supercharge Commenting

VS Code er opinn uppspretta ritstjóri sem þjónar sem vettvangur fyrir þróunaraðila til að setja fram sitt besta framlengingarverk. Markaðurinn er fullur af viðbótum til að gefa þér meiri kraft og notagildi þegar þú skrifar athugasemdir:

Betri athugasemdir

Athugasemdir kann að virðast vera lítill og valfrjáls hluti af kóðun, en það eru svo margar skapandi leiðir til að nota athugasemdir. Better Comments viðbótin hjálpar þér að bæta tilgangi og skýrleika við athugasemdirnar sem þú stráðir yfir með því að flokka þær í tilkynningar, fyrirspurnir, TODOs og aðra flokka. Og það er allt með auknum bónus litakóðunar fyrir bætta sýnileika og skipulag. Athugasemdir þínar verða leiðarljós og skiljur sem gera kóðann þinn snyrtilegri og aðgengilegri.

Athugasemd Akkeri

Athugasemdaakkeri halda þér á jörðu niðri í kóðanum þínum með nákvæmum punktum sem aðgreina hluta eða nauðsynlega staði innan. Ef þú prófar þessa viðbót gerir hún þér kleift að finna fljótt nákvæmar athugasemdir og athugasemdir. Ef verkefnið þitt er umfangsmikið og kóðinn þinn er að verða troðinn og erfitt að fylgja eftir gæti þetta gert það mun meltanlegra.

Polacode

Polacode umbreytir kóðanum þínum og athugasemdum í sjónrænt áhugaverðar, auðlæsilegar, deilanlegar myndir sem eru fullkomnar fyrir samfélagsmiðla. Það gerir þér kleift að breyta stærð, litakóða, breyta bakgrunni og fleira. Þú nýtur góðs af meiri læsileika og allir liðsfélagar geta unnið saman og deilt innsýn miklu auðveldara.

Hvers vegna athugasemd?

Athugasemdir eru ekki bara reit til að merkja við eða einhver valfrjáls verk sem orðsterkt fólk gerir; það er óaðskiljanlegur hluti af kóðun. Hér eru nokkrar af ástæðunum fyrir því:

Skýrleiki

Kóðarar leitast við að gera hið óleysanlega skiljanlegt. Að skrifa kóða sem virkar getur stundum verið einfaldari en að skrifa kóða sem er auðvelt að skilja og fylgja eftir. Athugasemdir eru áttaviti þróunaraðila - ómetanleg hjálp til að sigla um víðáttur kóða, hvort sem þær eru léttar og ungar eða þéttar og þroskaðar. Þú gætir verið að fást við flókin reiknirit eða fáránlega viðskiptaferla. Hvað sem því líður veita athugasemdir kunnuglegt hald í hafsjó margbreytileika.

Samvinna

Athugasemdir eru gagnlegar þegar þú ert sólóhönnuður. En þau eru nauðsynleg þegar þú vinnur sem teymi ef þú vilt að verkefnið þitt nái einhverjum framförum. Innan samvinnu átaks leyfa athugasemdir mörgum forriturum að vinna óaðfinnanlega saman, jafnvel þegar þeir hafa ekki samskipti. Liðsmenn fá að útskýra kóðann og deila hugsunarferli sínu og rökstuðningi á bak við ákvarðanir sínar. Þetta þjónar sem brú sem gerir öllum kleift að vera á sömu blaðsíðu með bæði verkefnið og hvern annan.

Villuleit

Ef þú lendir í því að endurskoða gamlan kóða eða reyna að kemba eitthvað sem gerir þig dularfulla, verða athugasemdir þínar til bjargar. Þeir halda skrá yfir fyrri rökfræði og hugsunarferli sem getur bent þér á hugsanlega gölluð rökfræði og getur leitt þig aftur til uppruna villunnar. Með þessari áminningu um hvar þú hafðir verið í fortíðinni geturðu snúið við erfiðum breytingum, fínstillt eldri kóða og komið þér aftur á réttan kjöl.

Ábendingar um árangursríkar athugasemdir

Nú veistu hvernig á að nota flýtileiðir athugasemda, hafa nokkrar þægilegar viðbótarviðbætur og skilur aðstæður þegar athugasemdir eru gagnlegastar. Allt sem þú átt eftir er að íhuga nokkrar bestu starfsvenjur um athugasemdir og þú munt hafa útskrifast úr kóðunar athugasemdanámskeiðinu.

Vertu hnitmiðaður

Það er listfengi í því að skilja eftir hnitmiðaðar, auðmeltanlegar athugasemdir. Skildu bara nóg inn til að gefa framtíðarsjálfinu þínu eða liðsmönnum þínum réttu hugmyndina, en ekki svo mikið til að vera yfirþyrmandi. Hvert orð í athugasemd þinni ætti að hafa tilgang og hjálpa til við að byggja á skilaboðunum sem þú ert að reyna að koma á framfæri. Ef athugasemd þín er of stutt gæti hún ekki komið boðskap sínum á framfæri, en ef hún er of löng er líklegra að þú farir yfir hana eða ruglist í framtíðinni.

Forðastu augljósar athugasemdir

Mikilvægi ætti að vera aðal áhyggjuefni þitt við að búa til skýran og skiljanlegan kóða. Ef þú skrifar kóðann þinn nú þegar þannig að merking hans sé augljós, þá er engin þörf á að nefna eitthvað sem sést við fyrstu sýn. Leyfðu kóðanum að tala þegar hann getur og notaðu athugasemdir til að bæta við auka samhengi eða veita ný sjónarhorn.

Notaðu athugasemdir við „Af hverju“, ekki „Hvað“

Kóðinn þinn setur fram staðreyndir um það sem er að gerast. En athugasemdir geta sagt dýpri sögu. Þeir miðla hvatningu og hugsunarferlum á bak við ákvarðanir þínar. Hvers vegna valdir þú þetta reiknirit fram yfir annað? Hvaða gildrur voru að hafa í huga? Kannski hefurðu prófað einhvern kóða sem margir myndu mæla með, en hann virkaði ekki eða virkaði ekki vel. Þú getur komið miklu meira á framfæri en bara leiðbeiningar með vel útfærðum athugasemdum.

Skildu eftir athugasemd

VS Code athugasemdareiginleikinn gæti verið meira en þægindi. Ef þú notar það til fulls getur munurinn á siglingahæfni og skiljanleika kóðagrunnsins þíns verið gríðarlegur. Bætt við snjöllum viðbótum og ítarlegri stefnu, gætirðu fljótlega búið til vel skjalfestan kóða sem er eins og meistaraverk.

Skilur þú eftir margar athugasemdir til að útskýra kóðann þinn? Eða notarðu aðallega athugasemdir til að útiloka bilaðan eða tilraunakóða frá villuleitinni? Segðu okkur sögu þína í athugasemdunum hér að neðan. Þeir eru komnir til að vera.