Información general de IntelliSense para JScript
Con IntelliSense para Microsoft JScript es más sencillo tener acceso a los elementos de programación de script de cliente en el editor de código en Visual Studio o Microsoft Visual Web Developer Express. IntelliSense proporciona opciones de código adecuadas al contexto mientras escribe código de script de cliente como, por ejemplo, propiedades, funciones y objetos. No es necesario que salga del editor de código para buscar documentación sobre parámetros o sintaxis. Puede seguir en el editor, buscar la información que necesite e insertar los elementos del lenguaje directamente en el código. IntelliSense para JScript funciona en gran medida como IntelliSense para los lenguajes de código administrado.
Este tema contiene las siguientes secciones:
Información general
Características de IntelliSense para JScript
Descripción de los errores de IntelliSense para JScript
Recursos adicionales
Para obtener más información sobre la funcionalidad de IntelliSense de Visual Studio, vea Utilizar IntelliSense.
Información general
IntelliSense le ayuda a escribir código con mayor rapidez y menos errores, ya que ofrece información mientras codifica. Cuando trabaja con scripts de cliente, IntelliSense elabora una lista de los objetos, funciones, propiedades y parámetros que están disponibles basándose en el contexto existente. Puede seleccionar una opción de codificación en la lista emergente que proporciona IntelliSense para completar el código.
Con IntelliSense resulta más sencillo completar las tareas siguientes:
Buscar información sobre los datos y métodos miembro.
Insertar directamente los elementos del lenguaje en el código.
Mantener el contexto sin necesidad de salir del editor de código.
Compatibilizar la personalización de IntelliSense con comentarios de código XML.
Cómo funciona IntelliSense para JScript
IntelliSense para JScript proporciona opciones de codificación basadas en todos los elementos del script que resulten relevantes para el contexto de programación en que se trabaja. Esto incluye los elementos de scripting del archivo actual. Asimismo, se incluye cualquier código al que se haga referencia directa o indirectamente en el script, por ejemplo, las referencias al archivo de script, al script de ensamblado, al servicio y a las páginas asociadas.
Determinar el contexto de IntelliSense
El contexto de programación se crea en función de los elementos siguientes:
Las funciones que se definen en el bloque actual del script. Los bloques de scripts insertados son compatibles con los archivos que tienen las extensiones de nombre de archivo .aspx, .ascx, .master, .html y .htm.
Los elementos script con un atributo src que señala a un archivo de script. El archivo de script de destino debe tener la extensión de nombre de archivo .js.
Archivos JScript que hacen referencia a otros archivos JScript mediante la utilización de la directiva references.
Referencias a servicios Web XML.
Los controles ScriptManager y ScriptManagerProxy, si la aplicación web es una aplicación ASP.NET AJAX.
La Microsoft Ajax Library, si está trabajando con una aplicación web ASP.NET habilitada para AJAX.
Nota
IntelliSense no es compatible con script que esté en atributos de controladores de eventos en elementos HTML ni que se defina en atributos href.
Procesar la información de IntelliSense
Para proporcionar IntelliSense para JScript, Visual Studio efectúa las operaciones siguientes:
Crea una lista de archivos dependientes JScript que se basa en las referencias que contiene el documento activo, así como en la realización de un examen recursivo de las referencias del script de los archivos a los que se hace referencia.
Recorre la lista y recopila información de los tipos y otros datos pertinentes de cada archivo.
Agrega los datos y los transfiere al motor de JScript, el cual pone a disposición de IntelliSense la información sobre los tipos y los datos.
Supervisa los archivos por si hubiera cambios que hubiesen afectado a la lista de IntelliSense y actualiza la lista según sea necesario.
Volver al principio
Características de IntelliSense para JScript
IntelliSense para JScript admite los objetos siguientes:
Elementos del Modelo de objetos de documento (DOM)
Objetos intrínsecos
Variables, funciones y objetos definidos por el usuario
Referencias a archivos externos
Comentarios en código XML
Objetos ASP.NET AJAX
Elementos DOM HTML
IntelliSense para JScript proporciona referencias de programación para los elementos DOM HTML dinámicos (DHTML), como body, form y div. IntelliSense sólo muestra los elementos que están incluidos en el documento y la página maestra actuales. IntelliSense para JScript también admite los objetos document y window, así como sus miembros.
Objetos intrínsecos
IntelliSense para JScript proporciona referencias de programación para los objetos intrínsecos de forma nativa Array, String, Math, Date y Number. Para obtener más información acerca de los objetos intrínsecos, vea Objetos intrínsecos.
Variables, funciones y objetos definidos por el usuario
Al cambiar un archivo JScript, Visual Studio examina los documentos que están abiertos y a los que se hace referencia con el fin de identificar todos los recursos de código disponibles. Esto incluye las variables, funciones y objetos que haya creado. Posteriormente, estos recursos se ponen a disposición de IntelliSense para JScript.
Para obtener más información sobre variables, funciones y objetos definidos por el usuario, vea Crear objetos propios en el sitio web de MSDN.
Referencias a archivos externos
En lugar de escribir el script de cliente íntegro en una página, puede hacer referencia a los archivos externos que incluyen código del scripting. De esta forma resulta más sencilla la reutilización del código entre páginas y permite que el explorador almacene en memoria caché el script de cliente.
Si está trabajando con una página web habilitada para ASP.NET AJAX, puede hacer referencia a los archivos de script mediante la utilización del objeto ScriptReference del control ScriptManager.
En el siguiente ejemplo se muestra el marcado que utiliza un objeto ScriptReference en un control ScriptManager para hacer referencia a un archivo de script.
<asp:ScriptManager ID="ScriptManager1" runat="server">
<Scripts>
<asp:ScriptReference Path="~/Scripts/JScript.js" />
</Scripts>
</asp:ScriptManager>
Si no está trabajando con una página web habilitada para ASP.NET AJAX, puede hacer referencia a un archivo de script externo mediante el atributo src en la etiqueta de apertura de un elemento script. El atributo src especifica la dirección URL de un archivo externo que contiene datos o código fuente.
En el ejemplo siguiente se muestra el marcado que utiliza el atributo src en una etiqueta <script> para hacer referencia a un archivo de script.
<script type="text/javascript" src="~/Scripts/JScript.js">
</script>
IntelliSense también admite archivos de script que se incrustan como recursos en un ensamblado en aplicaciones web ASP.NET AJAX. Para obtener más información sobre cómo utilizar recursos de script incrustados, vea Tutorial: Incrustar un archivo JavaScript como recurso en un ensamblado.
Directivas de referencias
Con una directiva references, Visual Studio puede establecer una relación entre el script que está modificando actualmente y otros scripts. La directiva references le permite incluir un archivo de script en el contexto de scripting del archivo de script actual. Esto habilita IntelliSense para poder hacer referencias, mientras codifica, a las funciones, tipos y campos definidos externamente.
Cree una directiva references con formato de comentario XML. La directiva se debe declarar en el archivo antes que cualquier script. Una directiva reference puede incluir una referencia a un script basado en discos, basado en ensamblados, basado en servicios o basado en páginas.
En el ejemplo siguiente se muestra cómo utilizar las directivas de referencia basadas en discos.
/// <reference path="ScriptFile1.js" />
/// <reference path="Scripts/ScriptFile2.js" />
/// <reference path="../ScriptFile3.js" />
/// <reference path="~/Scripts/ScriptFile4.js" />
En el ejemplo siguiente se muestra cómo crear una referencia a un script basado en ensamblados.
/// <reference name "Ajax.js" assembly="System.Web.Extensions, ..." />
En el ejemplo siguiente se muestra cómo hacer referencia a un script basado en servicios:
/// <reference path="MyService.asmx" />
/// <reference path="Services/MyService.asmx" />
/// <reference path="../MyService.asmx" />
/// <reference path="~/Services/MyService.asmx" />
Nota
IntelliSense para JScript no es compatible con scripts contenidos en archivos de servicios Web (.asmx) en proyectos de aplicaciones web (WAP).
En el ejemplo siguiente se muestra cómo hacer referencia a un script basado en páginas.
/// <reference path="Default.aspx" />
/// <reference path="Admin/Default.aspx" />
/// <reference path="../Default.aspx" />
/// <reference path="~/Admin/Default.aspx" />
Las reglas siguientes se aplican a una directiva reference.
El comentario XML de reference se debe declarar antes que cualquier script.
Debe utilizar la sintaxis de los comentarios XML con tres barras diagonales. Se omiten las referencias realizadas mediante sintaxis de comentarios estándar (dos barras diagonales).
Sólo se puede especificar un archivo o recurso por directiva.
No se permiten referencias múltiples a los scripts basados en páginas.
Si se especifica una referencia de página, no se permite ningún otro tipo de directivas de referencia.
Los nombres de archivo utilizan rutas de acceso relativas. Puede utilizar el operador tilde (~) para crear rutas relativas de acceso a la raíz de la aplicación.
Se omiten las rutas de acceso absolutas.
Se omiten las referencias a los archivos que no están en el proyecto actual.
No se procesarán las directivas de referencia en las páginas a las que se hace referencia (es decir, las directivas de referencia no se resuelven de forma recursiva para las páginas). Únicamente se incluye el script al que hace referencia directamente la página.
Comentarios de código XML
Los comentarios de código XML son descripciones textuales que se agregan al script. Estas descripciones se mostrarán con IntelliSense cuando haga referencia al script con comentarios. Los comentarios de código XML sólo están disponibles en los archivos, ensamblados y servicios a los que se hace referencia.
Puede incluir comentarios de código XML para proporcionar un resumen y para facilitar información sobre los parámetros y el valor que devuelve una función. En el ejemplo siguiente se muestra un script que utiliza comentarios de código XML:
function areaFunction(radiusParam)
{
/// <summary>Determines the area of a cicle based on a radius parameter.</summary>
/// <param name="radius" type="Number">The radius of the circle.</param>
/// <returns type="Number">Returns a number that represents the area.</returns>
var areaVal;
areaVal = Math.PI * radiusParam * radiusParam;
return areaVal;
}
IntelliSense puede mostrar referencias a código para los comentarios XML en las siguientes situaciones de referencia a archivos:
Un archivo .aspx que hace referencia a un archivo .js.
Un archivo .js que hace referencia a otro archivo .js.
Un archivo .js que hace referencia a un archivo .aspx.
IntelliSense no está disponible cuando un archivo .aspx hace referencia a otro archivo .aspx.
Para obtener más información sobre cómo agregar comentarios de código XML con el fin de proporcionar IntelliSense para JScript , vea Tutorial: IntelliSense para JScript.
Objetos ASP.NET AJAX
ASP.NET AJAX también es compatible con IntelliSense para JScript. ASP.NET AJAX incluye un marco de cliente que amplía los tipos estándar que están disponibles en ECMAScript (JavaScript y JScript). Para que IntelliSense para JScript pueda proporcionar detalles sobre los objetos ASP.NET AJAX, se han agregado comentarios de código XML en toda la Microsoft Ajax Library. Estos comentarios de código XML se muestran cuando utiliza los tipos y miembros de la biblioteca de ASP.NET AJAX.
Nota
IntelliSense para JScript no muestra los miembros privados. Los miembros privados se indican en ASP.NET AJAX mediante un guión bajo (_) inicial.
Descripción de los errores de IntelliSense para JScript
El motor de IntelliSense para JScript en Visual Studio proporciona automáticamente una validación mediante la comprobación de los vínculos de referencia del script y la ejecución del preprocesador. La validación del vínculo de referencia del script se determina según el contexto de programación. Si no se encuentra una referencia determinada, Visual Studio proporciona información de error sobre la referencia. El informe de errores del preprocesador se genera cuando surge un error en la ejecución de los archivos dependientes.
Para obtener más información sobre cómo se determina la validación de un vínculo, consulte Determinación del contexto de IntelliSense. Para obtener más información sobre cómo se determinan los errores del preprocesador de impresión, vea Procesar la información de IntelliSense.
Invocar la validación de JScript
En Visual Studio, la validación de IntelliSense para JScript se invoca de dos maneras:
En estado inactivo. La validación se invoca automáticamente en estado inactivo en cualquier documento activo que contenga script.
Manualmente. También puede invocar manualmente la validación de IntelliSense para JScript. Para ello, en el menú Edición, haga clic en Avanzado y, a continuación, haga clic Validar documento. Este comando se aplica a todos los documentos abiertos.
Resultados de la validación
Cuando Visual Studio no puede resolver las referencias del script, o si otro tipo de errores de scripting imposibilitan que el motor del IntelliSense recopile los resultados completos del contexto de scripting actual, Visual Studio proporciona comentarios de las maneras siguientes:
Elementos subrayados en el editor. El subrayado ondulado en rojo indica los errores. Si mantiene el puntero del mouse sobre el error, aparecerá una ventana (información sobre herramientas) que mostrará la descripción del error.
Ventana Lista de errores. La ventana Lista de errores muestra la descripción del error, el archivo donde se produjo, el número de línea y de columna, y el proyecto. Para mostrar la ventana Lista de errores, en el menú Ver, haga clic en Lista de errores.
Volver al principio
Recursos adicionales
Tutorial: IntelliSense para JScript
Cómo: Crear comentarios de código XML JScript
Volver al principio
Vea también
Tareas
Tutorial: IntelliSense para JScript
Asignar referencias de script de forma dinámica