El llenguatge de programació per ordinador Microsoft Visual Basic ha estat popular als cercles de programació durant molts anys. Els programadors l’utilitzen per a tota mena de projectes. Les variants d’aquest llenguatge de programació s’utilitzen per a pàgines web i altres tipus de programes de Visual Basic s’utilitzen per a moltes de les aplicacions de Windows que fem servir cada dia. Un dels elements essencials de Visual Basic és la possibilitat d’incloure comentaris, que són notes incrustades al codi que no tenen un propòsit de codi funcional. Visual Basic utilitza un protocol específic per distingir-los del codi. L’addició de comentaris és extremadament important en la majoria de projectes per ajudar els lectors de codis humans a llegir correctament els mòduls de codi. Si heu d’afegir comentaris a Visual Basic, aquí teniu alguns dels passos fonamentals per assegurar-vos que ho feu correctament.
Passos
Pas 1. Determineu quin tipus de comentari voleu afegir
Els programadors tenen diversos propòsits principals per als comentaris que determinen el format i l’estil exactes del que s’inclourà al comentari.
- Penseu en els comentaris del mòdul de codi. Els comentaris del mòdul són comentaris de nivell superior que solen descriure els propòsits generals del mòdul de codi, així com altra informació com ara drets d'autor, autoria i molt més.
- Valoreu la necessitat de fer comentaris al procediment. També s'han de comentar diversos procediments de codi funcional. Els comentaris del procediment es relacionen amb les funcions específiques del codi i ajuden a alertar altres programadors sobre els resultats exactes d’un procediment segons com s’escrigui.
Pas 2. Trieu categories d'ús detallades per als comentaris del vostre codi
Alguns tipus de comentaris, com els procediments, també presenten diferents formes. Compreneu aquests diferents usos per afegir els tipus adequats de comentaris al vostre programa.
- Avalueu l'ús de comentaris de propòsit per als procediments. Aquests descriuen què fa el procediment.
- Penseu en l’ús de comentaris de valor de retorn de la funció. Això ajudarà els altres a entendre quins valors es retornen mitjançant el procediment.
- Incloeu comentaris condicionals. Els comentaris condicionals poden descriure possibles condicions d'error i maneig d'errors, així com les condicions que s'han de complir perquè el codi funcioni correctament.
Pas 3. Trieu un format per als comentaris
També hi ha el problema de com afegir comentaris a línies de codi específiques.
- Utilitzeu comentaris esquerrans. Aquests comentaris comencen a l'esquerra de la pantalla i continuen tot el camí a través d'una línia. Normalment, el programador ha de finalitzar arbitràriament el comentari a la part dreta de la pantalla, baixar a una nova línia i continuar el comentari.
- Utilitzeu comentaris en línia. Els comentaris en línia tenen un apòstrof directament després d'un tros de codi i es col·loquen a la mateixa línia.
Pas 4. Utilitzeu un apòstrof per marcar el començament dels vostres comentaris
Aquest és el pas clau per escriure comentaris al codi. L’apòstrof és el protocol de text específic que el compilador de Visual Basic reconeix per als comentaris. Sense això, l’ordinador intentarà llegir els comentaris com a codi.
