În codificare, comentariile sunt una dintre puținele moduri de a păstra gândurile pentru viitor. Ele vă pot ajuta să treceți peste fragmente de cod și pot fi de ajutor pentru următorul dezvoltator care va încerca să înțeleagă ce ați scris cu câteva zile înainte. Dacă utilizați Visual Studio Code (VS Code), nu este nevoie să introduceți neobosit delimitatorii de comentarii de fiecare dată. VS Code are o funcție de comandă rapidă încorporată care economisește secunde (și chiar minute) din timpul tău.
Comanda rapidă pentru comentarii de cod VS
Pentru cei grăbiți, iată biletul tău de aur:
- Pentru un comentariu pe o singură linie, utilizați combinația de taste Ctrl + / pe Windows sau Linux sau Cmd + / pe un Mac.
,
- Pentru un comentariu de bloc, utilizați Shift + Alt + A pe Windows sau Linux sau Shift + Opțiune + A pe un Mac.
,
- Pentru a comenta codul, puteți apăsa Ctrl + K + C pe Windows sau Cmd + K + U pe Mac.
,
Majoritatea codificatorilor comentează mult. Și nu este vorba doar de a lăsa comentarii reale, dar poate mai important, vei comenta și decomenta codul. Acest lucru este viabil pentru testare, experimentare și depanare.
Comenzile rapide sunt acolo pentru a face acest lucru mai plăcut. Acestea accelerează navigarea și modificarea, permițându-vă să comutați comentariile fără a perturba impulsul de codare.
Comentând dincolo de elementele de bază
În timp ce comenzile rapide de bază sunt un adevărat cadou, este mult mai mult pentru a comenta VS Code. Să aprofundăm:
Comutați Comentarii
Cea mai bună parte a comenzilor rapide pentru comentarii VS Code este caracteristica lor de comutare. Nu trebuie să vă jucați și să eliminați manual fiecare marcator de comentariu dacă vă răzgândiți (sau în timpul depanării). În schimb, utilizați doar aceleași comenzi rapide. Cu aceleași combinații de taste, puteți comuta rapid între codul comentat și cel necomentat pentru a rămâne organizat atunci când aveți cea mai mare nevoie.
Comentând mai multe rânduri
Dacă trebuie să dezactivați un bloc lung de cod sau să lăsați un comentariu extins și detaliat, nu doriți să pierdeți timp adăugând cu greu comentarii rând cu rând. Deci, în schimb, puteți selecta liniile pe care doriți să le dezactivați și să utilizați comanda rapidă pentru comentarii pentru a permite VS Code să introducă comentarii în fiecare linie.
Comentarii imbricate
Uneori, inserarea de comentarii într-un bloc de cod poate duce la rezultate neașteptate și erori dacă delimitatorii nu se potrivesc foarte bine. Acesta este locul în care Intellisense de la Visual Studio Code vă poate ajuta. Acesta va ajusta formatarea comentariilor pentru tine chiar și într-un bloc deja comentat, astfel încât să nu existe conflicte cu comentariile imbricate.
Extensii la Supercharge Commenting
VS Code este un editor open-source care servește drept platformă pentru dezvoltatori pentru a-și pune cele mai bune activități de extensie. Piața este plină de extensii pentru a vă oferi mai multă putere și utilitate atunci când comentați:
Comentarii mai bune
Comentarea poate părea o parte mică și opțională a codării, dar există atât de multe moduri creative de a folosi comentariile. The Comentarii mai bune extensia vă ajută să adăugați scop și claritate comentariilor despre care le presărați, clasificându-le în alerte, interogări, TODO și alte categorii. Și asta este totul cu bonusul suplimentar de codare de culori pentru o vizibilitate și organizare îmbunătățite. Comentariile dvs. devin puncte de ghidare și separatoare care vă fac codul mai ordonat și mai accesibil.
Comentariu Ancore
Comentariu Ancore vă mențin în codul dvs. cu puncte care disting secțiunile sau punctele esențiale din interior. Dacă încercați această extensie, vă va permite să găsiți rapid note și observații precise. Dacă proiectul tău este vast și codul tău devine înghesuit și greu de urmărit, acest lucru l-ar putea face mult mai ușor de digerat.
polishcode
polishcode transformă codul și comentariile dvs. în imagini interesante din punct de vedere vizual, ușor de citit, care pot fi partajate, perfecte pentru rețelele sociale. Vă permite să redimensionați, să codificați culorile, să schimbați fundalul și multe altele. Beneficiați de o mai mare lizibilitate, iar orice coechipier poate colabora și împărtăși informații mult mai ușor.
cum să obțineți text colorat în discordie
De ce Comenteaza?
Comentarea nu este doar o căsuță de bifat sau o corvoadă opțională pe care o fac oamenii pronunțați; este o parte integrantă a codificării. Iată câteva dintre motivele pentru asta:
Claritate
Codificatorii caută să facă inteligibilul intratabil. Scrierea unui cod care funcționează poate fi uneori mai simplă decât scrierea unui cod ușor de înțeles și de urmat. Comentariile sunt busola dezvoltatorului – un ajutor neprețuit pentru a naviga în întinderi de cod, fie ele ușoare și tinere sau dense și mature. S-ar putea să aveți de-a face cu algoritmi complicati sau cu procese de afaceri arcane. În orice caz, comentariile oferă o mână familiară într-o mare de complexitate.
Colaborare
Comentariile sunt utile atunci când ești un dezvoltator solo. Dar sunt necesare atunci când lucrați în echipă dacă doriți ca proiectul dvs. să progreseze. În cadrul unui efort de colaborare, comentariile permit mai multor dezvoltatori să lucreze împreună, chiar și atunci când nu interacționează. Membrii echipei pot să explice codul și să-și împărtășească procesele de gândire și raționamentul din spatele deciziilor lor. Acesta servește ca o punte care permite tuturor să fie pe aceeași pagină atât cu proiectul, cât și unul cu celălalt.
Depanare
Dacă te trezești că revizi codul vechi sau încerci să depanezi ceva care te încurcă, comentariile devin harul tău salvator. Ei păstrează o evidență a logicii tale trecute și a procesului de gândire care te poate îndruma către posibila logică defectuoasă și te poate duce înapoi la originile bug-ului. Cu acest reamintire a locului în care ați fost în trecut, puteți anula modificările problematice, puteți optimiza codul mai vechi și puteți reveni pe drumul cel bun.
Sfaturi pentru un comentariu eficient
Acum știi cum să folosești comenzile rapide pentru comentarii, să ai câteva extensii suplimentare convenabile și să înțelegi scenarii când comentarea este cea mai utilă. Tot ce ți-a mai rămas este să iei în considerare câteva bune practici de comentare și vei fi absolvit cursul de comentarii de codificare.
Fii concis
Există talent în a lăsa în urmă comentarii concise, ușor de digerat. Lăsați doar suficient pentru a oferi viitorului dvs. sau membrilor echipei ideea corectă, dar nu atât pentru a fi copleșitor. Fiecare cuvânt din comentariul tău ar trebui să aibă un scop și să ajute la construirea mesajului pe care încerci să-l transmit. Dacă comentariul dvs. este prea scurt, este posibil să nu-și transmită mesajul, dar dacă este prea lung, este mai probabil să treceți peste el sau să fiți confuz de el în viitor.
Evitați comentariile evidente
Relevanța ar trebui să fie preocuparea ta principală în crearea unui cod clar și ușor de înțeles. Dacă îți scrii deja codul astfel încât sensul său să fie evident, nu este nevoie să menționezi ceva ce poate fi văzut la prima vedere. Lasă codul să vorbească ori de câte ori poate și folosește comentarii pentru a adăuga context suplimentar sau pentru a oferi perspective noi.
Folosiți comentarii pentru „De ce”, nu „Ce”
Codul dvs. prezintă faptele a ceea ce se întâmplă. Dar comentariile pot spune o poveste mai profundă. Ele transmit motivațiile și procesele de gândire din spatele deciziilor tale. De ce ai ales acest algoritm peste altul? Care au fost capcanele de avut în vedere? Poate ați încercat un cod pe care mulți l-ar recomanda, dar nu a funcționat sau nu a funcționat bine. Puteți transmite mult mai mult decât simple instrucțiuni cu comentarii bine elaborate.
Lăsând un comentariu
Funcția de comentare VS Code ar putea fi mai mult decât o comoditate. Dacă profitați din plin de el, diferența de navigabilitate și înțelegere a bazei de cod poate fi masivă. Suplimentat cu extensii inteligente și o strategie amănunțită, puteți crea în curând un cod bine documentat, care se citește ca o capodopera.
Lasă multe comentarii pentru a-ți explica codul? Sau folosiți mai ales comentariile pentru a exclude codul rupt sau experimental din depanator? Spune-ne povestea ta în comentariile de mai jos. Ei sunt aici pentru a rămâne.
