Arvutiprogrammeerimiskeel Microsoft Visual Basic on olnud programmeerimisringkondades populaarne juba aastaid. Programmeerijad kasutavad seda igasuguste projektide jaoks. Selle programmeerimiskeele variante kasutatakse veebilehtede jaoks ja muud tüüpi Visual Basicu programme kasutatakse paljudes Windowsi rakendustes, mida me igapäevaselt kasutame. Visual Basicu üheks oluliseks elemendiks on võimalus lisada kommentaare, mis on koodi sisse manustatud märkused, millel pole funktsionaalset koodi eesmärki. Visual Basic kasutab nende koodist eristamiseks spetsiaalset protokolli. Kommentaaride lisamine on enamiku projektide puhul äärmiselt oluline, et aidata inimkoodi vaatajatel koodimooduleid õigesti lugeda. Kui teil on vaja Visual Basicule kommentaare lisada, on siin mõned põhitoimingud, mis aitavad teil seda õigesti teha.
1
Määrake, millist tüüpi kommentaari soovite lisada. Programmeerijatel on kommentaaride jaoks mitu erinevat peamist eesmärki, mis määravad kommentaaridesse lisatava täpse vormi ja stiili. Kaaluge koodimooduli kommentaare. Mooduli kommentaarid on kõrgema taseme kommentaarid, mis tavaliselt kirjeldavad koodimooduli üldisi eesmärke, aga ka muud teavet, nagu autoriõigus, autorlus ja palju muud. Hinnake protseduuri kommentaaride vajadust. Kommenteerida tuleks ka erinevaid funktsionaalse koodi protseduure. Protseduuri kommentaarid on seotud koodi spetsiifiliste funktsioonidega ja aitavad teisi programmeerijaid hoiatada protseduuri täpsete tulemuste eest vastavalt sellele, kuidas see on kirjutatud.
2
Valige oma koodi kommentaaride jaoks üksikasjalikud kasutuskategooriad. Teatud tüüpi kommentaarid, näiteks protseduuride kommentaarid, on samuti erineval kujul. Mõistke neid erinevaid kasutusviise, et lisada oma programmile õiget tüüpi kommentaare. Hinnake protseduuride jaoks mõeldud kommentaaride kasutamist. Need kirjeldavad, mida protseduur teeb. Kaaluge funktsiooni tagastamisväärtuse kommentaaride kasutamist. Need aitavad teistel mõista, milliseid väärtusi protseduur tagastab. Kaasake tingimuslikud kommentaarid. Tingimuslikud kommentaarid võivad kirjeldada võimalikke tõrketingimusi ja vigade käsitlemist, samuti tingimusi, mis peavad olema täidetud, et kood korralikult töötaks.
3
Valige kommentaaride vorming. Probleemiks on ka see, kuidas konkreetsetele koodiridadele kommentaare lisada. Kasutage vasakukäelisi kommentaare. Need kommentaarid algavad ekraani vasakust servast ja jätkuvad terve tee üle joone. Tavaliselt peab kodeerija suvaliselt lõpetama kommentaari ekraani paremas servas, minema uuele reale ja jätkama kommentaari.Kasutage reasiseseid kommentaare. Reasiseste kommentaaride juures on apostroof vahetult pärast koodiosa ja need asetatakse samale reale.
4
Kasutage oma kommentaaride alguse tähistamiseks apostroofi. See on võtmesamm kommentaaride tegelikult koodi kirjutamiseks. Apostroof on spetsiifiline tekstiprotokoll, mille Visual Basicu kompilaator kommentaaride jaoks ära tunneb. Ilma selleta proovib arvuti kommentaare koodina lugeda.