Skip to content

Potenciar intellisense de javascript con comentarios xmldoc

by en 5 agosto, 2011

Hace algunos días les comenté cómo se podía referenciar archivos JS a otro archivo con el propósito de mejorar el intellisense de Javascript.

La gran ventaja es que con esto logramos que nuestro intellisense nos muestre funciones desde otros archivos, lo malo es que muchas veces no sabemos para qué era la función o qué son los parámetros que recibe.

Como se puede ver en la imágen a la izquierda, reconoce una función holaMundo que no está definida en el archivo actual. En la primera línea tenemos la referencia al archivo donde está definida esa función. Lamentablemente no sabemos que hace la función, sólo sabemos que se llama holaMundo… más que eso, nada…

Para agregar la descripción de la función y de sus parámetros debemos utilizar los comentarios xml-doc que se utilizan en el code-behind. Usando las etiquetas <summary> y <params>.

En la imagen de la derecha se puede apreciar el archivo mi_js. Este archivo es el que está siendo referenciado en la imagen anterior. Como se puede ver, la función holaMundo no tiene comentarios, mientras que la función suma_enteros si tiene los comentarios. Note que los comentarios van DENTRO de la función, a diferencia del code-behind, en el que los comentarios van fuera de la función.

Estos comentarios permiten mostrar la descripción de la función y de cada uno de los parámetros. Para hacer estos comentarios es importante que se coloquen 3 slashs (caracter /) y luego un espacio. Se debe escribir a mano las etiquetas, ya que, a diferencia del code-behind, no las agregará automaticamente el IDE.

 

 

¿El resultado de estos comentarios?

Veanlo ustedes mismos:

 

 

 

 

 

 

 

Espeor que esta entrada les haya ayudado a mejorar su experiencia de desarrollo en Visual Studio 2010🙂

Enjoy🙂

Dejar un comentario

Responder

Introduce tus datos o haz clic en un icono para iniciar sesión:

Logo de WordPress.com

Estás comentando usando tu cuenta de WordPress.com. Cerrar sesión / Cambiar )

Imagen de Twitter

Estás comentando usando tu cuenta de Twitter. Cerrar sesión / Cambiar )

Foto de Facebook

Estás comentando usando tu cuenta de Facebook. Cerrar sesión / Cambiar )

Google+ photo

Estás comentando usando tu cuenta de Google+. Cerrar sesión / Cambiar )

Conectando a %s

A %d blogueros les gusta esto: