Compartir a través de

Comentarios en código (Visual Basic)

A medida que lee los ejemplos de código, a menudo encuentra el símbolo de comentario ('). Este símbolo indica al compilador de Visual Basic que omita el texto que sigue o el comentario. Los comentarios son breves notas explicativas agregadas al código para beneficiarse de esas lecturas.

Es recomendable comenzar todos los procedimientos con un breve comentario que describa las características funcionales del procedimiento (lo que hace). Esto es para su propio beneficio y la ventaja de cualquier otra persona que examine el código. Debe separar los detalles de implementación (cómo lo hace el procedimiento) de los comentarios que describen las características funcionales. Cuando incluya detalles de implementación en la descripción, recuerde actualizarlos al actualizar la función.

Los comentarios pueden seguir una instrucción en la misma línea o ocupar una línea completa. Ambos se muestran 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 requiere más de una línea, use el símbolo de comentario en cada línea, como se muestra en el ejemplo siguiente.

' 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.

Directrices de comentarios

En la tabla siguiente se proporcionan instrucciones generales para qué tipos de comentarios pueden preceder a una sección de código. Estas son sugerencias; Visual Basic no aplica reglas para agregar comentarios. Escriba lo que mejor funciona, tanto para usted como para cualquier otra persona que lea el código.

Tipo de comentario Descripción del comentario
Propósito Describe lo que hace el procedimiento (no cómo lo hace)
Supuestos Enumera cada variable externa, control, archivo abierto u otro elemento al que accede el procedimiento.
Efectos Enumera cada variable externa afectada, control o archivo, y el efecto que tiene (solo si no es obvio)
Entradas Especifica el propósito del argumento.
Devoluciones Explica los valores devueltos por el procedimiento

Recuerde los siguientes puntos:

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

  • Las variables, los controles y los procedimientos deben denominarse claramente lo suficiente como para que solo se necesiten comentarios para detalles complejos de implementación.

  • Los comentarios no pueden seguir una secuencia de continuación de línea en la misma línea.

Para agregar o quitar símbolos de comentario para un bloque de código, seleccione una o varias líneas de código y elija los botones Comentario (Comentario de Visual Basic en Visual Studio). y Quitar marca de comentario (el botón Quitar marca de comentario de Visual Basic en Visual Studio).) de la barra de herramientas Editar .

Nota:

También puede agregar comentarios al código si precede al texto con la REM palabra clave . Sin embargo, el símbolo y los ' botones Comentario/sin marca de comentario son más fáciles de usar y requieren menos espacio y memoria.

Consulte también