Mostrando entradas con la etiqueta Documentación. Mostrar todas las entradas
Mostrando entradas con la etiqueta Documentación. Mostrar todas las entradas

viernes, 19 de abril de 2013

Parte I. Crear documentación XML en Visual Basic .NET

En este minitutorial vamos a ver los principios básicos para documentar nuestro código fuente para que así Visual Studio nos muestre la información en IntelliSense.
Cuando estamos programando qué útil es IntelliSense explicándonos cómo funcionan las funciones, propiedades, etc., y sus correspondientes parámetros, pero, ¿cómo podemos hacerlo nosotros en nuestro código? Pues de una forma muy sencilla e intuitiva.

Ejemplo IntelliSense

Primero vamos a empezar creando una clase la cual vamos a documentar. Para ello, en primer lugar creamos un nuevo proyecto y a ese nuevo proyecto (en principio será únicamente un formulario) le vamos a añadir una clase a la que llamaremos ClaseMostrarFormulario. El funcionamiento de esta clase es trivial, simplemente está compuesta por una serie de propiedades y un método. Las propiedades son para dar tamaño, color, texto y el tiempo que va a mostrar el formulario y tiene un método que hará que se muestre el formulario. El código de la clase es el siguiente.