Limbajul de programare Microsoft Visual Basic este popular în cercurile de programare de mulți ani. Programatorii îl folosesc pentru tot felul de proiecte. Variantele acestui limbaj de programare sunt utilizate pentru paginile web, iar alte tipuri de programe Visual Basic sunt utilizate pentru multe dintre aplicațiile Windows pe care le folosim în fiecare zi. Unul dintre elementele esențiale ale Visual Basic este abilitatea de a include comentarii, care sunt note încorporate în cod care nu au un scop funcțional de cod. Visual Basic utilizează un protocol specific pentru a le distinge de cod. Adăugarea de comentarii este extrem de importantă în majoritatea proiectelor pentru a ajuta vizualizatorii de coduri umane să citească corect modulele de cod. Dacă trebuie să adăugați comentarii la Visual Basic, iată câțiva pași fundamentali pentru a vă asigura că faceți acest lucru corect.
Pași
Pasul 1. Stabiliți ce tip de comentariu doriți să adăugați
Programatorii au mai multe scopuri principale diferite pentru comentarii care determină formatul exact și stilul a ceea ce va fi inclus în comentariu.
- Luați în considerare comentariile modulului de cod. Comentariile de module sunt comentarii de nivel superior care descriu de obicei scopurile generale ale modulului de cod, precum și alte informații precum drepturile de autor, autorul și multe altele.
- Evaluează necesitatea comentariilor procedurii. De asemenea, ar trebui comentate diverse proceduri funcționale de cod. Comentariile de procedură se referă la funcțiile specifice ale codului și ajută la alertarea altor programatori cu privire la rezultatele exacte ale unei proceduri în funcție de modul în care este scrisă.
Pasul 2. Alegeți categorii detaliate de utilizare pentru comentariile dvs. de cod
Unele tipuri de comentarii, cum ar fi comentariile de procedură, vin, de asemenea, sub diferite forme. Înțelegeți aceste utilizări diferite pentru a adăuga tipurile potrivite de comentarii la programul dvs.
- Evaluează utilizarea comentariilor de scop pentru proceduri. Acestea descriu ce face procedura.
- Luați în considerare utilizarea comentariilor despre valoarea de returnare a funcției. Acestea îi vor ajuta pe alții să înțeleagă ce valori sunt returnate prin procedură.
- Includeți comentarii condiționate. Comentariile condiționale pot descrie posibile condiții de eroare și gestionarea erorilor, precum și condițiile care trebuie îndeplinite pentru ca codul să funcționeze corect.
Pasul 3. Alegeți un format pentru comentarii
Există, de asemenea, problema modului în care veți adăuga comentarii la anumite linii de cod.
- Utilizați comentarii stângaci. Aceste comentarii încep din stânga ecranului și continuă tot drumul peste o linie. În mod obișnuit, programatorul trebuie să termine arbitrar comentariul din partea dreaptă a ecranului, să coboare la o nouă linie și să continue comentariul.
- Folosiți comentarii în linie. Comentariile în linie au un apostrof direct după o bucată de cod și sunt plasate pe aceeași linie.
Pasul 4. Folosiți un apostrof pentru a marca începutul comentariilor dvs
Acesta este pasul cheie pentru scrierea comentariilor în cod. Apostroful este protocolul text specific pe care compilatorul Visual Basic îl recunoaște pentru comentarii. Fără aceasta, computerul va încerca să citească comentariile ca cod.
