Comentarios. Comentarios especiales: TODO, FIXME, NOTE

-->

Crear Comentarios a nuestras lineas de código

Una de las primeras cosas que debemos de hacer en nuestro programa es comentarlos. Es una herramienta que nos vá a servir a nosotros (y a los que leen nuestro código fuente) para explicar que hace nuestro código.

¿para que sirve?

 Un programa no se escribe en un día, podemos tardar semanas y meses en hacerlo, o incluso puede que lo dejemos porque estemos “atascados” y que posteriormente lo continuamos.

Para facilitar esto, es importante que en los puntos importantes (definiciones de variables, subrutinas, o lo que consideremos importante), a la hora de escribir el código añadamos comentarios del tipo “esta variable hace....”, “esta parte del programa lee...”

¿como se hace?

Los comentarios se definen con una apostrofe (‘) y luego el texto. 

Con doble apostrofe (''), se marca en negrita el comentario, verá más abajo la aplicación que tiene...

El comentario debe de estar al final del codigo o en una sola linea:

Ejemplo

-->

‘ ‘Comentario

‘hola

Otro ejemplo

-->

‘Gambas.....

Public Sub main()

print “hola” ‘esta linea de código escribe “hola” en la consola

End

Ademas con el doble apostrofe ('') podemos indicar en la ayuda interactiva del Ide de Gambas nos indice el comentario que tengamos... 

Te explico, mira la siguiente captura de pantalla.

Como ves, en el dibujo, he comentado con doble apóstrofe la definición de una función, no te preocupes si no sabes que es una función, en los próximos capítulos te lo explicaré.

El comentario lo he introducido con doble apóstrofe (se marca en negrita)...

Y cada vez que escribamos el nombre de la función, en la ayuda interactiva del IDE de Gambas, aparecerá dicho comentario.

Es algo que nos servirá para escribir saber que necesita la función, que hace dicha función, o lo que desees indicar.

Comentarios especiales: Apostrofes + Parentesis, Corchetes ó Llaves
Para facilitar la lectura del códigos, podemos usar parentesis, corchetes o llaves, (con el apostrofe por delantes) para agrupar los códigos que pertenecen a un bucle u ordenes if..then.

Por ejemplo:

Estos comentarios los podremos usar en:

•  las definiciones de propiedades
•  procedimientos y subrutinas
•  y funciones de nuestros programas. 

¿enlentece poner muchos comentarios en los programas?

No, ya que el interprete al detectar el comentario no hace nada con él, pasando a la siguiente línea de código...

Asi pues, no tienes ninguna escusa para no incluir  comentarios en tus programas..

Añadido al tema de comentarios:
 Comentario  que comienza con las palabras TODO:, FIXME: o NOTE: Foro gambas-es.org

TODO viene de "to do" y significa "por hacer, pendiente de hacer".
FIXME viene a significar "arréglame" y solemos usarlo cuando sabemos que ese código necesita una mejora, aunque funcione.
NOTE  simplemente una anotación o recordatorio.