Intellisense de Javascript en Visual Studio “Orcas”

En Febrero escribí un post llamado Mi primer vistazo a Orcas (inglés). Comentaba alguna de las mejoras para el desarrollo web que iban a venir con Visual Studio "Orcas". Si no lo habéis leído, hacedlo.

Una de las característica más esperada es el soporte para intellisense de JavaScript en Visual Studio Orcas (esta feature también funciona con la edición Visual Web Developer Express).

Si alguna vez os habéis sentido frustados por tener que escribir cada línea de Javascript, os gustará que Visual Studio "Orcas" traiga soporte completo para el intellisense de Javascript en los archivos .aspx, .html, así como en archivos externos .js.  Tanto soporte para Javascript como para código cliente de ASP .NET AJAX.

Podéis leer algunas de las características para Javascript de Visual Studio Orcas en estos dos post del blog del equipo de herramientas web para Visual Studio:

Como Wally escribió recientemente, una de las cosas "chulas" del intellisense de Javascript en Visual Studio "Orcas" está diseñado para funcionar "out of the box". Es decir, no tenéis que ejecutar ninguna herramienta en vuestros archivos Javascript para que funcione el intellisense. Ni siquiera teneis que escribir vuestro código javascript de ninguna forma especial para que funciones. Si escribís vuestros códigos de javascript en un archivo externo, obtendremos soporte intellisense en Visual Studio automáticamente.

Commentarios para documentación de Javascript opcional.

Visual Studio nos permite además, opcionalmente, añadir comentarios para la documentación en vuestros códigos/librerías que pueden facilitar el trabajo del motor de intellisense, así como permitir a los desarrolladores aportar documentación en los comentarios que el motor del intellisense del VS puede coger y usarlo para resúmenes, validación y descripciones.

Por ejemplo, si añadimos este comentario resumen XML en nuestro código:

Visual Studio mostrará automáticamente el detalle del resumen, así como ayuda en línea mientras escribimos los valores de los parámetros:

Formato de documentación en los comentarios de Javascript.

Bertrand Le Roy del equipo de ASP .NET escribió un post que cuenta en detalle el formato de los comentarios de Javascript para la documentación que usan tanto ASP .NET AJAX y Visual Studio "Orcas". Entre otras cosas, incluye detalles sobre:

  • Cómo añadir resúmenes de los detalles de las clases, métodos y parámetros.
  • Cómo localizar la documentación en Javascript.
  • Cómo indicar que un archivo Javascript externo requiere (o referencia) otro archivo externo y asume que los métodos y clases de aquél están al alcance cuando el primer archivo Javascript se usa (esto es increíblemente útil cuando usamos cualquier librería de AJAX).

Os recomiendo que el hechéis un vistazo aquí.

El ASP.NET AJAX Control Tookit también tiene un MSBuild que podéis añadir a vuestros proyectos web para poder obtener esta documentación en vuestros archivos Javascript cuando compiláis un proyecto en modo release. Ésto os permite mantener versiones debug/descripción de vuestros Javascripts en tiempo de desarrollo, y entonces poder tener un puente para generar versiones optimizadas para descargas efficientes en tiempo de ejecución.

Espero que sirva.

Scott.

Traducido por: Juan María Laó Ramos. Microsoft Student Partner

Deja un comentario