Kako koristiti prečac komentara u VS kodu

U kodiranju, komentari su jedan od rijetkih načina očuvanja misli za budućnost. Oni vam mogu pomoći da zabljesnete isječke koda i mogu biti od pomoći sljedećem programeru koji će pokušavati razumjeti što ste napisali danima prije. Ako koristite Visual Studio Code (VS Code), nema potrebe svaki put neumorno upisivati ​​razdjelnike komentara. VS Code ima ugrađenu značajku prečaca koja štedi sekunde (pa čak i minute) vašeg vremena.

Prečac za komentar Quick VS Code

Za one kojima se žuri, evo vaše zlatne karte:

• Za komentar u jednom retku upotrijebite kombinaciju tipki Ctrl + / u sustavu Windows ili Linux ili Cmd + / na Macu.
  ,
• Za blokiranje komentara upotrijebite Shift + Alt + A na Windowsima ili Linuxu ili Shift + Option + A na Macu.
  ,
• Za komentiranje koda možete pritisnuti Ctrl + K + C na Windowsu ili Cmd + K + U na Macu.
  ,

Većina kodera puno komentira. I ne radi se samo o ostavljanju stvarnih komentara, nego što je možda još važnije, komentirat ćete i uklanjati komentare iz koda. Ovo je održivo za testiranje, eksperimentiranje i otklanjanje pogrešaka.

Prečaci su tu da ovo učine ukusnijim. Oni ubrzavaju navigaciju i izmjene, dopuštajući vam da mijenjate komentare bez ometanja zamaha kodiranja.

Komentiranje izvan osnova

Dok su osnovni prečaci pravi dar, ima još mnogo toga za komentiranje VS Codea. Zaronimo dublje:

Uključi komentare

Najbolji dio prečaca za komentare VS Codea je njihova značajka prebacivanja. Ne morate petljati i ručno uklanjati svaku oznaku komentara ako se predomislite (ili tijekom otklanjanja pogrešaka). Umjesto toga, samo koristite iste prečace. S istim kombinacijama tipki možete se brzo prebacivati ​​između komentiranog i nekomentiranog koda kako biste ostali organizirani kada vam je to najpotrebnije.

Komentiranje više redaka

Ako trebate isključiti dugačak blok koda ili ostaviti opsežan, detaljan komentar, ne želite trošiti vrijeme na mukotrpno dodavanje komentara redak po redak. Umjesto toga, možete odabrati retke koje želite deaktivirati i upotrijebiti prečac za komentar kako biste dopustili VS Codeu da umetne komentare u svaki redak.

Ugniježđeni komentari

Ponekad umetanje komentara u blok koda može dovesti do neočekivanih rezultata i pogrešaka ako se graničnici ne podudaraju dobro. Ovdje vam Visual Studio Code Intellisense može pomoći. Prilagodit će vam oblikovanje komentara čak i unutar već komentiranog bloka, tako da neće biti sukoba s ugniježđenim komentarima.

Proširenja Supercharge komentiranja

VS Code je uređivač otvorenog izvornog koda koji programerima služi kao platforma za izlaganje svojih najboljih proširenja. Tržište je prepuno proširenja koja vam daju više snage i korisnosti prilikom komentiranja:

Bolji komentari

Komentiranje se može činiti kao mali i neobavezan dio kodiranja, ali postoji toliko mnogo kreativnih načina za korištenje komentara. Proširenje Better Comments pomaže vam dodati svrhu i jasnoću komentarima o kojima posipate kategorizirajući ih u upozorenja, upite, TODO i druge kategorije. I to je sve s dodatnim bonusom označavanja bojama za poboljšanu vidljivost i organizaciju. Vaši komentari postaju smjernice i razdjelnici koji vaš kod čine urednijim i pristupačnijim.

Sidra komentara

Sidra komentara drže vas utemeljenima na vašem kodu pomoću točaka koje razlikuju dijelove ili bitna mjesta unutar. Ako isprobate ovo proširenje, omogućit će vam brzo pronalaženje preciznih bilješki i primjedbi. Ako je vaš projekt golem i vaš kod postaje pretrpan i teško ga je pratiti, to bi ga moglo učiniti puno probavljivijim.

Polacode

Polacode pretvara vaš kôd i komentare u vizualno zanimljive, lako čitljive slike koje se mogu dijeliti i koje su savršene za društvene medije. Omogućuje promjenu veličine, kodiranje boja, promjenu pozadine i još mnogo toga. Imate koristi od veće čitljivosti, a svi suigrači mogu puno lakše surađivati ​​i dijeliti uvide.

Zašto komentirati?

Komentiranje nije samo okvir za označavanje ili neki neobavezan posao koji rade mnogoriječni ljudi; to je sastavni dio kodiranja. Evo nekih od razloga za to:

Jasnoća

Koderi nastoje učiniti neukrotivo razumljivim. Pisanje koda koji funkcionira ponekad može biti jednostavnije od pisanja koda koji je lako razumjeti i slijediti. Komentari su programerov kompas – neprocjenjiva pomoć u navigaciji prostranstvima koda, bili oni laki i mladi ili gusti i zreli. Možda imate posla sa zamršenim algoritmima ili tajanstvenim poslovnim procesima. U svakom slučaju, komentari pružaju poznato držanje u moru složenosti.

Suradnja

Komentari su korisni kada ste solo programer. No oni su neophodni kada radite kao tim ako želite da vaš projekt napreduje. Unutar zajedničkih napora, komentari omogućuju većem broju programera da nesmetano rade zajedno čak i kada ne komuniciraju. Članovi tima moraju objasniti kod i podijeliti svoje procese razmišljanja i obrazloženja iza svojih odluka. Ovo služi kao most koji omogućuje svima da budu na istoj stranici i s projektom i jedni s drugima.

Otklanjanje pogrešaka

Ako ponovno pregledavate stari kod ili pokušavate otkloniti pogreške u nečemu što vas zbunjuje, komentari postaju vaš spas. Oni čuvaju zapis o vašoj prošloj logici i misaonom procesu koji vas može uputiti na moguću pogrešnu logiku i može vas odvesti natrag do podrijetla buga. Uz ovaj podsjetnik gdje ste bili u prošlosti, možete vratiti problematične promjene, optimizirati stariji kod i vratiti se na pravi put.

Savjeti za učinkovito komentiranje

Sada znate kako koristiti prečace za komentare, imate neka zgodna dodatna proširenja i razumijete scenarije kada je komentiranje najkorisnije. Sve što vam preostaje jest razmotriti neke najbolje prakse komentiranja i završit ćete tečaj kodiranja komentara.

Budite koncizni

Ima umjetnosti u ostavljanju jezgrovitih, lako probavljivih komentara. Ostavite tek toliko da sebi ili članovima svog tima date pravu ideju, ali ne toliko da bude previše. Svaka riječ vašeg komentara trebala bi imati svrhu i pomoći u izgradnji poruke koju pokušavate prenijeti. Ako je vaš komentar prekratak, možda neće uspjeti prenijeti svoju poruku, ali ako je predugačak, veća je vjerojatnost da ćete ga u budućnosti preletjeti ili zbuniti.

Izbjegavajte očite komentare

Relevantnost bi trebala biti vaša primarna briga u stvaranju jasnog i razumljivog koda. Ako već pišete svoj kod tako da je njegovo značenje očito, nema potrebe spominjati nešto što se vidi na prvi pogled. Pustite kod da govori kad god može i koristite komentare za dodavanje dodatnog konteksta ili pružanje novih perspektiva.

Koristite komentare za "Zašto", a ne za "Što"

Vaš kod izlaže činjenice o tome što se događa. Ali komentari mogu ispričati dublju priču. Oni prenose motivaciju i proces razmišljanja koji stoje iza vaših odluka. Zašto ste odabrali ovaj algoritam umjesto nekog drugog? Koje su zamke trebale imati na umu? Možda ste isprobali neki kod koji bi mnogi preporučili, ali nije radio ili nije radio dobro. Dobro osmišljenim komentarima možete prenijeti mnogo više od pukih uputa.

Ostavljanje komentara

Značajka komentiranja VS Codea mogla bi biti više od pogodnosti. Ako to u potpunosti iskoristite, razlika u navigaciji i razumljivosti vaše baze kodova može biti ogromna. Nadopunjen pametnim proširenjima i temeljitom strategijom, uskoro biste mogli stvoriti dobro dokumentiran kod koji se čita kao remek-djelo.

Ostavljate li mnogo komentara da biste objasnili svoj kôd? Ili uglavnom koristite komentare kako biste isključili pokvareni ili eksperimentalni kod iz programa za ispravljanje pogrešaka? Recite nam svoju priču u komentarima ispod. Oni su ovdje da ostanu.