Comentarios en el código (Visual Basic)

Cuando lea ejemplos de código, encontrará el símbolo de comentario ('). Este símbolo solicita al compilador de Visual Basic que pase por alto el texto que aparece a continuación o el comentario. Los comentarios son notas cortas explicativas que se agregan al código para aportar mayor información a las personas que lo lean.

Una buena práctica de programación consiste en comenzar todos los procedimientos con un comentario breve que describe las características funcionales del procedimiento (lo que hace). Esto ayuda al desarrollador y a los que puedan examinar el código. Debería separar los detalles de implementación (cómo lo hace el procedimiento) de los comentarios que describen las características funcionales. Al incluir detalles de implementación en la descripción, recuerde actualizarlos en el momento de actualizar la función.

Los comentarios pueden ir a continuación de una instrucción en la misma línea, o pueden ocupar una línea completa. Ambas opciones quedan reflejadas en el código siguiente.

' This is a comment beginning at the left edge of the screen.
text1.Text = "Hi!"   ' This is an inline comment.

Si el comentario necesita más de una línea, utilice el símbolo de comentario en cada línea, como se muestra en el siguiente ejemplo:

' This comment is too long to fit on a single line, so we break  
' it into two lines. Some comments might need three or more lines.

Instrucciones sobre los comentarios

La tabla siguiente proporciona directrices generales sobre los tipos de comentarios que pueden preceder una sección de código. Se trata únicamente de sugerencias, ya que Visual Basic no tiene reglas obligatorias para agregar comentarios. Escriba lo que considere más conveniente, para uso propio o para cualquier otra persona que lea el código.

Tipo de comentario	Descripción del comentario
Finalidad	Describe qué hace el procedimiento (no cómo lo hace).
Suposiciones	Enumera cada variable externa, control, archivo abierto u otro elemento al cual el procedimiento tenga acceso.
Efectos	Enumera cada variable externa, control o archivo que esté afectado, y el efecto que tienen (únicamente si no es evidente).
Entradas	Especifica el propósito del argumento.
Valores devueltos	Explica los valores que devuelve el procedimiento

Recuerde los siguientes puntos:

• Cada declaración de variable importante debe incluir un comentario anterior que describa el uso de la variable que se declara.

• Las variables, controles y procedimientos deben tener un nombre lo suficientemente claro para asegurar que el uso de comentarios sólo sea necesario para detalles de implementación compleja.

• Después de la secuencia de continuación de línea no puede escribirse un comentario en la misma línea.

Puede agregar o quitar símbolos de comentario de un bloque de código seleccionando una o más líneas de código y eligiendo los botones Selección con comentarios () y Selección sin comentarios () de la barra de herramientas Edición.

Nota

También puede agregar comentarios al código poniendo la palabra clave REM antes del texto.Sin embargo, el símbolo ' y los botones Selección con comentarios y Selección sin comentarios son más fáciles de utilizar y requieren menos espacio y memoria.

Vea también

Tareas

Cómo: Crear documentación XML en Visual Basic

Referencia

Etiquetas XML recomendadas para comentarios de documentación (Visual Basic)

REM (Instrucción, Visual Basic)

Otros recursos

Documentar el código con comentarios XML

Convenciones de código y estructura de programas (Visual Basic)