Compartir a través de


Agregar notas a programas: utilizar comentarios

Actualización: noviembre 2007

En esta lección, obtendrá información sobre cómo crear comentarios en el código de sus programas.

El código que forma un programa puede ser difícil de leer y entender, sobre todo si el usuario no es la persona que lo escribió originalmente. Al utilizar comentarios, puede crear notas para sí mismo o para otros usuarios del código.

Los comentarios son entradas de texto del editor de código que el compilador de Visual Basic omite cuando se ejecuta el programa. Por tanto, puede escribir una nota que explique lo que hace una sección determinada del programa, o bien un aviso para finalizar las tareas de programación incompletas.

El comentario se crea iniciando una línea con el carácter '. El ejemplo siguiente muestra cómo crear un comentario.

' This is a comment. WOW!

También puede agregar comentarios al final de las líneas, así como usar el carácter '. Este procedimiento suele realizar para proporcionar comentarios sobre líneas individuales de código, como se ve en el ejemplo siguiente.

MsgBox("Hello World!") ' This line causes a message box to appear.

Al igual que con los comentarios de una única línea, el programa omite todo lo que vaya después del carácter ' de esa línea.

Utilizar comentarios para depuración

Otro uso común de los comentarios es evitar temporalmente que una línea de código se ejecute mientras depura su programa. Por ejemplo, suponga que tenía una línea que mostraba un cuadro de mensaje.

MsgBox("Hello World!")

Si quiere ejecutar el programa sin mostrar esa línea, pero no desea eliminarla permanentemente, utilice el carácter del comentario (') para ocultarla temporalmente de su programa, tal y como se muestra a continuación.

' MsgBox("Hello World!")

Como todo lo que va después del carácter ' se omite, el programa se ejecutará sin ejecutar esa línea. Puede quitar el carácter ' después y se mostrará el cuadro de mensaje.

¡Inténtelo!

Para insertar comentarios

  1. En el menú Archivo, elija Nuevoproyecto.

  2. En el cuadro de diálogo Nuevo proyecto, en el panel Plantillas, haga clic en Aplicación para Windows.

  3. En el cuadro Nombre, escriba Comments y, a continuación, haga clic en Aceptar.

    Se abrirá un nuevo proyecto de formularios Windows Forms.

  4. Haga doble clic en el formulario para abrir el Editor de código.

  5. En el controlador del evento Form1_Load, escriba el siguiente código.

    ' This code will cause two message boxes to appear
    MsgBox("This is Message Box 1") ' Display Message Box 1
    MsgBox("This is Message Box 2") ' Display Message Box 2
    
  6. Presione F5 para ejecutar el programa.

    El programa se inicia y se muestran los dos cuadros de mensaje de uno en uno.

  7. En el menú Depurar, elija Detener depuración para finalizar el programa.

  8. En el Editor de código, agregue un carácter de comentario (') a la primera línea del cuadro de mensaje, para que se lea lo siguiente.

    ' MsgBox("This is MessageBox 1") ' Ignore Message Box 1
    
  9. Presione F5 para ejecutar el programa.

    Observe que esta vez el programa omite la primera línea del cuadro de mensaje y sólo se muestra el segundo cuadro de mensaje.

Pasos siguientes

En esta lección, obtuvo información sobre cómo utilizar los comentarios para crear notas en su código y volver inactivas temporalmente líneas de código individuales. Con esta información finalizan las lecciones sobre la depuración. En el conjunto siguiente de lecciones, obtendrá información sobre cómo utilizar una base de datos para almacenar y recuperar información para el programa.

Siguiente lección: Administrar registros: utilizar datos en un programa

Vea también

Conceptos

Comentarios en código

Otros recursos

¿Qué salió mal? Encontrar y corregir errores mediante depuración