Arvutiprogrammeerimiskeel Microsoft Visual Basic on programmeerimisringkondades populaarne juba aastaid. Programmeerijad kasutavad seda igasuguste projektide jaoks. Selle programmeerimiskeele variante kasutatakse veebilehtede jaoks ja muud tüüpi Visual Basic programme kasutatakse paljude Windowsi rakenduste jaoks, mida kasutame iga päev. Visual Basicu üks olulisi elemente on võimalus lisada kommentaare, mis on koodi sisse manustatud märkmed, millel puudub funktsionaalne koodieesmärk. Visual Basic kasutab nende koodist eristamiseks spetsiaalset protokolli. Kommentaaride lisamine on enamikus projektides äärmiselt oluline, et aidata inimkoodi vaatajatel koodimooduleid õigesti lugeda. Kui teil on vaja Visual Basicule kommentaare lisada, on siin mõned põhilised sammud, et veenduda, et teete seda õigesti.
Sammud
Samm 1. Otsustage, millist tüüpi kommentaari soovite lisada
Programmeerijatel on kommentaaride jaoks mitu erinevat peamist eesmärki, mis määravad kommentaari sisu täpse vormi ja stiili.
- Mõelge koodimooduli kommentaaridele. Mooduli kommentaarid on kõrgema taseme kommentaarid, mis tavaliselt kirjeldavad koodimooduli üldisi eesmärke, aga ka muud teavet, nagu autoriõigus, autorsus ja muu.
- Hinnake protseduuri kommentaaride vajadust. Samuti tuleks kommenteerida erinevaid funktsionaalse koodi protseduure. Protseduuri kommentaarid on seotud koodi spetsiifiliste funktsioonidega ja aitavad hoiatada teisi programmeerijaid protseduuri täpsetest tulemustest vastavalt sellele, kuidas see on kirjutatud.
Samm 2. Valige oma koodikommentaaride jaoks üksikasjalikud kasutuskategooriad
Teatavaid kommentaare, näiteks protseduurikommentaare, esitatakse ka erinevates vormides. Mõistke neid erinevaid kasutusviise, et oma programmile õigeid kommentaare lisada.
- Hinnake protseduuride eesmärgikommentaaride kasutamist. Need kirjeldavad protseduuri toimivust.
- Kaaluge funktsiooni tagastamise väärtuse kommentaaride kasutamist. Need aitavad teistel mõista, millised väärtused protseduuriga tagastatakse.
- Kaasa tingimuslikud kommentaarid. Tingimuslikud kommentaarid võivad kirjeldada võimalikke veatingimusi ja veakäsitlust, samuti tingimusi, mis peavad olema täidetud, et kood korralikult töötaks.
Samm 3. Valige kommentaaride vorming
Samuti on probleem selles, kuidas lisate kommentaarid konkreetsetele koodiridadele.
- Kasutage vasakukäelisi kommentaare. Need kommentaarid algavad ekraani vasakust servast ja jätkuvad kogu joone ulatuses. Tavaliselt peab kooder suvaliselt lõpetama kommentaari ekraani parema serva lähedal, laskuma uuele reale ja jätkama kommentaari.
- Kasutage reas kommentaare. Reasisesed kommentaarid on apostroofiga otse kooditüki järel ja paigutatakse samale reale.
Samm 4. Märkige kommentaaride algus apostroofiga
See on peamine samm kommentaaride tegelikuks koodiks kirjutamiseks. Apostroof on konkreetne tekstiprotokoll, mille Visual Basicu kompilaator kommentaaride jaoks ära tunneb. Ilma selleta proovib arvuti kommentaare koodina lugeda.