Ako používať skratku komentára v kóde VS

V kódovaní sú komentáre jedným z mála spôsobov uchovania myšlienok do budúcnosti. Môžu vám pomôcť preniknúť do útržkov kódu a môžu byť užitočné pre ďalšieho vývojára, ktorý sa bude snažiť pochopiť, čo ste napísali pred niekoľkými dňami. Ak používate Visual Studio Code (VS Code), nie je potrebné zakaždým neúnavne vypisovať oddeľovače komentárov. VS Code má vstavanú funkciu skratiek, ktorá šetrí sekundy (a dokonca minúty) vášho času.

Skratka rýchleho komentára VS kódu

Pre tých, ktorí sa ponáhľajú, tu je váš zlatý lístok:

• Pre jednoriadkový komentár použite kombináciu klávesov Ctrl + / v systéme Windows alebo Linux alebo Cmd + / v systéme Mac.
  ,
• Pre blokový komentár použite Shift + Alt + A v systéme Windows alebo Linux alebo Shift + Option + A v systéme Mac.
  ,
• Ak chcete komentovať kód, môžete stlačiť Ctrl + K + C v systéme Windows alebo Cmd + K + U v systéme Mac.
  ,

Väčšina kóderov veľa komentuje. A nejde len o zanechanie skutočných komentárov, ale čo je možno dôležitejšie, budete komentovať a odkomentovať kód. To je životaschopné pre testovanie, experimentovanie a ladenie.

Skratky sú tu, aby to bolo chutnejšie. Urýchľujú navigáciu a zmeny, umožňujú vám prepínať komentáre bez narušenia dynamiky kódovania.

Komentovanie nad rámec základov

Zatiaľ čo základné skratky sú skutočným darom, v komentovaní VS Code je toho oveľa viac. Poďme sa ponoriť hlbšie:

Prepnúť komentáre

Najlepšia časť o skratkách komentárov VS Code je ich prepínacia funkcia. Ak si to rozmyslíte (alebo počas ladenia), nemusíte sa hrabať a ručne odstraňovať každú značku komentára. Namiesto toho stačí použiť rovnaké skratky. Pomocou rovnakých kombinácií kláves môžete rýchlo prepínať medzi komentovaným a nekomentovaným kódom, aby ste mali prehľad, keď to najviac potrebujete.

Komentovanie viacerých riadkov

Ak potrebujete stlmiť dlhý blok kódu alebo zanechať rozsiahly, podrobný komentár, nechcete tráviť čas namáhavým pridávaním komentárov riadok po riadku. Namiesto toho si môžete vybrať riadky, ktoré chcete deaktivovať, a pomocou skratky komentárov nechať VS Code vložiť komentáre do každého riadku.

Vnorené komentáre

Niekedy môže vkladanie komentárov do bloku kódu viesť k neočakávaným výsledkom a chybám, ak sa oddeľovače skutočne nezhodujú. Tu vám môže pomôcť Intellisense Visual Studio Code. Upraví za vás formátovanie komentárov aj v rámci už zakomentovaného bloku, takže nedôjde ku konfliktom s vnorenými komentármi.

Rozšírenia Supercharge Komentovanie

VS Code je editor s otvoreným zdrojovým kódom, ktorý slúži ako platforma pre vývojárov, aby mohli realizovať svoje najlepšie rozšírenia. Trh je plný rozšírení, ktoré vám poskytnú viac výkonu a užitočnosti pri komentovaní:

Lepšie komentáre

Komentovanie sa môže zdať ako malá a voliteľná časť kódovania, ale existuje toľko kreatívnych spôsobov, ako použiť komentáre. Rozšírenie Better Comments vám pomáha pridať účel a jasnosť komentárov, ktoré pridávate, ich kategorizáciou do upozornení, dopytov, úloh a ďalších kategórií. A to je všetko s pridaným bonusom farebného kódovania pre lepšiu viditeľnosť a organizáciu. Vaše komentáre sa stanú vodiacimi bodmi a oddeľovačmi, vďaka ktorým bude váš kód prehľadnejší a prístupnejší.

Kotvy komentárov

Komentáre kotvy vás udržia pri zemi vo vašom kóde s presnými bodmi, ktoré rozlišujú sekcie alebo dôležité miesta vo vnútri. Ak vyskúšate toto rozšírenie, umožní vám rýchlo nájsť presné poznámky a poznámky. Ak je váš projekt rozsiahly a váš kód je preplnený a je ťažké ho sledovať, môže byť oveľa stráviteľnejší.

Polacode

Polacode premení váš kód a komentáre na vizuálne zaujímavé, ľahko čitateľné a zdieľateľné obrázky, ktoré sú ideálne pre sociálne médiá. Umožňuje vám zmeniť veľkosť, farebné označenie, zmeniť pozadie a ďalšie. Profitujete z väčšej čitateľnosti a všetci spoluhráči môžu oveľa jednoduchšie spolupracovať a zdieľať poznatky.

Prečo Komentovať?

Komentovanie nie je len zaškrtávacie políčko alebo nejaká voliteľná práca, ktorú robia rozvláčni ľudia; je to neoddeliteľná súčasť kódovania. Tu sú niektoré z dôvodov:

Jasnosť

Kóderi sa snažia urobiť neovládateľné zrozumiteľným. Písanie kódu, ktorý funguje, môže byť niekedy jednoduchšie ako písanie kódu, ktorý je ľahko pochopiteľný a dodržiavateľný. Komentáre sú kompasom vývojára – neoceniteľnou pomôckou pri navigácii v rozsahu kódu, či už sú ľahké a mladé alebo husté a zrelé. Možno máte čo do činenia so spletitými algoritmami alebo tajomnými obchodnými procesmi. V každom prípade komentáre poskytujú známe držanie v mori zložitosti.

Spolupráca

Komentáre sú užitočné, keď ste samostatný vývojár. Sú však potrebné pri tímovej práci, ak chcete, aby váš projekt pokročil. V rámci spoločného úsilia umožňujú komentáre viacerým vývojárom bezproblémovo spolupracovať, aj keď neinteragujú. Členovia tímu vysvetlia kód a podelia sa o svoje myšlienkové procesy a zdôvodnenie svojich rozhodnutí. Slúži ako most, ktorý umožňuje všetkým byť na rovnakej stránke s projektom aj navzájom.

Ladenie

Ak sa ocitnete pri prezeraní starého kódu alebo pri pokuse o odladenie niečoho, čo vás mystifikuje, komentáre sa stanú vašou záchranou. Vedú záznamy o vašej minulej logike a myšlienkovom procese, ktoré vás môžu upozorniť na možnú chybnú logiku a môžu vás priviesť späť k pôvodu chyby. S touto pripomienkou toho, kde ste boli v minulosti, môžete vrátiť problematické zmeny, optimalizovať starší kód a vrátiť sa na správnu cestu.

Tipy na efektívne komentovanie

Teraz viete, ako používať skratky pre komentáre, máte niekoľko praktických doplnkových rozšírení a rozumiete scenárom, kedy je komentovanie najužitočnejšie. Jediné, čo vám zostáva, je zvážiť niektoré osvedčené postupy pri komentovaní a budete mať za sebou kurz s komentármi o kódovaní.

Buďte struční

Nechať za sebou stručné, ľahko stráviteľné komentáre je umenie. Nechajte len toľko, aby ste svojmu budúcemu ja alebo členom tímu poskytli správnu predstavu, ale nie toľko, aby to bolo ohromujúce. Každé slovo vášho komentára by malo mať svoj účel a malo by pomôcť stavať na posolstve, ktoré sa snažíte odovzdať. Ak je váš komentár príliš stručný, môže sa stať, že nedokáže vyjadriť svoje posolstvo, no ak je príliš dlhý, je pravdepodobnejšie, že ho v budúcnosti preletíte alebo budete zmätení.

Vyhnite sa očividným komentárom

Pri vytváraní jasného a zrozumiteľného kódu by mala byť vaším hlavným záujmom relevantnosť. Ak už napíšete svoj kód tak, aby bol jeho význam zrejmý, nie je potrebné spomínať niečo, čo je vidieť na prvý pohľad. Nechajte kód hovoriť kedykoľvek je to možné a použite komentáre na pridanie ďalšieho kontextu alebo poskytnutie nových perspektív.

Použite komentáre pre „prečo“, nie „čo“

Váš kód obsahuje fakty o tom, čo sa deje. Komentáre však môžu rozprávať hlbší príbeh. Vyjadrujú motiváciu a myšlienkové procesy za vašimi rozhodnutiami. Prečo ste uprednostnili tento algoritmus pred iným? Aké úskalia bolo potrebné mať na pamäti? Možno ste vyskúšali nejaký kód, ktorý by mnohí odporučili, ale nefungoval alebo nefungoval dobre. Dokážete sprostredkovať oveľa viac než len pokyny s dobre vytvorenými komentármi.

Zanechanie komentára

Funkcia komentovania kódu VS môže byť viac ako len pohodlie. Ak to naplno využijete, rozdiel v ovládateľnosti a zrozumiteľnosti vašej kódovej základne môže byť obrovský. Vďaka šikovným rozšíreniam a dôkladnej stratégii by ste mohli čoskoro vytvoriť dobre zdokumentovaný kód, ktorý sa číta ako majstrovské dielo.

Zanechávate veľa komentárov na vysvetlenie vášho kódu? Alebo väčšinou používate komentáre na vylúčenie nefunkčného alebo experimentálneho kódu z debuggeru? Povedzte nám svoj príbeh v komentároch nižšie. Sú tu, aby zostali.