Vue d'ensemble de JScript IntelliSense

  • Article

Mise à jour : novembre 2007

IntelliSense pour Microsoft JScript facilite l'accès aux éléments de programmation de script client dans l'éditeur de code dans Visual Studio ou Microsoft Visual Web Developer Express. IntelliSense offre des choix de code adaptés au contexte lors de la saisie du code de script client, tels que des propriétés, des fonctions et des objets. Il n'est pas nécessaire d'abandonner l'éditeur de code pour rechercher de la documentation sur les paramètres ou la syntaxe. En effet, vous pouvez rester dans l'éditeur de code, trouver les informations dont vous avez besoin et insérer les éléments de langage directement dans votre code. IntelliSense pour JScript fonctionne de façon très similaire à IntelliSense pour les langages de code managé.

Cette rubrique contient les sections suivantes :

  • Contexte

  • Fonctionnalités de JScript IntelliSense

  • Description des erreurs de JScript IntelliSense

  • Ressources supplémentaires

Pour plus d'informations sur le fonctionnement d'IntelliSense de Visual Studio, consultez Utilisation de la fonctionnalité IntelliSense.

Contexte

IntelliSense vous aide à écrire du code plus vite et avec moins d'erreurs en fournissant des informations pendant l'écriture du code. Pendant que vous travaillez avec le script client, IntelliSense répertorie les objets, fonctions, propriétés et paramètres qui sont disponibles selon votre contexte actuel. Vous pouvez sélectionner une option de programmation dans la liste contextuelle fournie par IntelliSense pour compléter le code.

IntelliSense simplifie la réalisation des tâches suivantes :

  • Recherche d'informations sur les membres.

  • Insertion d'éléments de langage directement dans le code.

  • Conservation du contexte sans quitter l'éditeur de code.

  • Prise en charge da la fonction IntelliSense personnalisée avec les commentaires de code XML.

Comment JScript IntelliSense fonctionne

JScript IntelliSense fournit des choix de programmation selon le script qui est pertinent à votre contexte de programmation actuel. Cela inclut des éléments de script dans le fichier courant. Cela comprend également tout code référencé directement ou indirectement depuis votre script, comme les références de fichier de script, les références de script d'assembly, les références de service et les références associées aux pages.

Détermination du contexte IntelliSense

Votre contexte de programmation actuel est créé selon les éléments suivants :

  • Les fonctions définies dans le bloc de script actuel. Les blocs de script inline sont pris en charge dans les fichiers qui ont les extensions .aspx., .ascx, .master, .html, et .htm.

  • Chaque élément script contenant un attribut src qui pointe vers un fichier de script. Le fichier de script cible doit avoir l'extension de nom de fichier .js.

  • Les fichiers JScript qui référencent d'autres fichiers JScript en utilisant la directive references.

  • Références aux services Web XML.

  • Les contrôles ScriptManager et ScriptManagerProxy, si l'application Web est une application ASP.NET AJAX.

  • Microsoft AJAX Library, si vous travaillez dans une application Web ASP.NET compatible AJAX.

    Remarque :

    IntelliSense n'est pas pris en charge pour le script qui se trouve dans les attributs de gestionnaire d'événements sur les éléments HTML, ou qui est défini dans les attributs href.

Traitement des informations IntelliSense

Pour fournir JScript IntelliSense, Visual Studio exécute les opérations suivantes :

  • Crée une liste de fichiers JScript dépendants basés sur les références contenues dans le document actif, et selon l'examen récursif des références de script dans les fichiers référencés.

  • Parcourt la liste et collecte des informations de type et d'autres données pertinentes à partir de chaque fichier.

  • Regroupe les données et les transmet au moteur JScript, qui met les informations de type et les données à la disposition d'IntelliSense.

  • Surveille les fichiers pour les modifications qui peuvent affecter la liste IntelliSense et met à jour la liste si nécessaire.

Retour au début

Fonctionnalités de JScript IntelliSense

JScript IntelliSense prend en charge les objets suivants :

  • Éléments DOM (Document Object Model)

  • Objets intrinsèques

  • Variables définies par l'utilisateur, fonctions et objets

  • Références de fichiers externes

  • Commentaires de code XML

  • Objets ASP.NET AJAX

Éléments DOM HTML

JScript IntelliSense fournit des références de programmation pour éléments DOM DHTML (Dynamic HTML), tels que body, form et div. Seuls les éléments inclus dans le document actuel et la page maître sont affichés par IntelliSense. JScript IntelliSense prend en charge également les objets window et leurs membres document.

Objets intrinsèques

JScript IntelliSense fournit des références de programmation pour les objets intrinsèques en mode natif Array, String, Math, Date et Number. Pour plus d'informations sur les objets intrinsèques, consultez Objets intrinsèques.

Variables définies par l'utilisateur, fonctions et objets

Lorsque vous modifiez un fichier JScript, Visual Studio analyse les documents ouverts et référencés pour déterminer toutes les ressources de code disponibles. Cela inclut les variables, fonctions et objets que vous avez créés. Ces ressources sont ensuite disponibles pour JScript IntelliSense. 

Pour plus d'informations sur les variables, fonctions et objets définis par l'utilisateur, consultez Création de vos propres objets (en anglais) sur le site Web MSDN.

Références de fichiers externes

Au lieu d'écrire tout le script client dans une page, vous pouvez référencer des fichiers externes qui incluent le code de script. Cela vous simplifie la réutilisation du code entre les pages et permet la mise en cache du script client par le navigateur.

Si vous travaillez avec une page Web compatible ASP.NET AJAX, vous pouvez référencer des fichiers de script à l'aide de l'objet ScriptReference du contrôle ScriptManager.

L'exemple suivant montre un balisage qui utilise un objet ScriptReference dans un contrôle ScriptManager pour référencer un fichier de script.

<asp:ScriptManager ID="ScriptManager1" >
  <Scripts>
    <asp:ScriptReference Path="~/Scripts/JScript.js" />
  </Scripts>
</asp:ScriptManager>

Si vous ne travaillez pas avec une page Web compatible ASP.NET AJAX, vous pouvez référencer un fichier de script externe en utilisant l'attribut src dans la balise d'ouverture d'un élément script. L'attribut src spécifie l'URL pour un fichier externe qui contient le code source ou les données.

L'exemple suivant montre un balisage qui utilise l'attribut src dans une balise <script> pour référencer un fichier de script.

<script type="text/javascript" src="~/Scripts/JScript.js">
  
</script>

IntelliSense prend également en charge des fichiers de script qui sont incorporés comme ressources dans un assembly des applications Web ASP.NET AJAX. Pour plus d'informations sur les ressources de script incorporées, consultez Procédure pas à pas : incorporation d'un fichier JavaScript en tant que ressource dans un assembly.

Directives de références

Une directive references permet à Visual Studio d'établir une relation entre le script vous modifiez actuellement et d'autres scripts. La directive references vous permet d'inclure un fichier de script dans le contexte de script du fichier de script actuel. Cela permet à IntelliSense de référencer des fonctions définies extérieurement, des types et des champs lors de l'écriture de code. 

Vous créez une directive references dans le formulaire d'un commentaire XML. La directive doit être déclarée dans le fichier avant tout script. Une directive reference peut inclure une référence de script sur disque, une référence de script basée sur un assembly, une référence de script basée sur un service ou une référence de script basée sur une page.

L'exemple suivant montre des exemples d'utilisation de directives de référence basées sur disque.

/// <reference path="ScriptFile1.js" />

/// <reference path="Scripts/ScriptFile2.js" />

/// <reference path="../ScriptFile3.js" />

/// <reference path="~/Scripts/ScriptFile4.js" />

L'exemple suivant indique comment créer une référence à un script basé sur un assembly.

/// <reference name "Ajax.js" assembly="System.Web.Extensions, ..." />

L'exemple suivant indique comment référencer un script basé sur un service :

/// <reference path="MyService.asmx" />

/// <reference path="Services/MyService.asmx" />

/// <reference path="../MyService.asmx" />

/// <reference path="~/Services/MyService.asmx" />

Remarque :

JScript IntelliSense n'est pas pris en charge pour le script contenu dans les fichiers de services Web (.asmx) WAP (Web Application Projects).

L'exemple suivant indique comment référencer un script basé sur une page.

/// <reference path="Default.aspx" />

/// <reference path="Admin/Default.aspx" />

/// <reference path="../Default.aspx" />

/// <reference path="~/Admin/Default.aspx" />

Les règles suivantes s'appliquent à une directive reference.

  • Le commentaire XML reference doit être déclaré avant tout script.

  • Vous devez utiliser la syntaxe des commentaires XML avec trois barres obliques. Les références effectuées en utilisant la syntaxe de commentaire standard (deux barres obliques) sont ignorées.

  • Un seul fichier ou ressource peut être spécifié(e) par directive.

  • Les références multiples aux scripts basés sur des pages ne sont pas autorisées.

  • Si une référence de page est spécifiée, aucun autre type de directives de référence n'est autorisé.

  • Les noms de fichiers utilisent des chemins d'accès relatifs. Vous pouvez utiliser l'opérateur tilde (~) pour indiquer des chemins d'accès relatifs au niveau de la racine de l'application.

  • Les chemins d'accès absolus sont ignorés.

  • Les références aux fichiers hors du projet actuel sont ignorées.

  • Les directives de référence dans les pages référencées ne sont pas traitées ; autrement dit, les directives de référence ne sont pas résolues de manière récursive pour les pages. Seul le script qui est référencé directement par la page est inclus.

Commentaires de code XML

Les commentaires de code XML sont des descriptions de texte que vous ajoutez au script. Ces descriptions de texte sont affichées avec IntelliSense lorsque vous référencez le script commenté. Les commentaires de code XML sont uniquement disponibles dans les fichiers, les assemblys et les services référencés.

Vous pouvez inclure des commentaires de code XML pour fournir un résumé et donner des informations à propos des paramètres et la valeur de retour d'une fonction. L'exemple suivant affiche un script qui utilise des commentaires de code 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 peut afficher des références de code pour les commentaires XML dans les scénarios de référence de fichier suivants :

  • Un fichier .aspx qui référence un fichier .js.

  • Un fichier .js qui référence un autre fichier .js.

  • Un fichier .js qui référence un fichier .aspx.

IntelliSense n'est pas disponible lorsqu'un fichier .aspx référence un autre fichier .aspx.

Pour plus d'informations sur l'ajout de commentaires de code XML pour fournir à JScript IntelliSense, consultez Procédure pas à pas : JScript IntelliSense.

Objets ASP.NET AJAX

ASP.NET AJAX prend également en charge JScript IntelliSense. ASP.NET AJAX inclut une infrastructure cliente qui étend les types standard qui sont disponibles dans ECMAScript (JavaScript et JScript). Pour permettre à JScript IntelliSense de fournir des détails à propos des objets ASP.NET AJAX, des commentaires de code XML ont été ajoutés partout dans Microsoft AJAX Library. Ces commentaires de code XML sont affichés lorsque vous utilisez les types et les membres contenus dans ASP.NET AJAX Library.

Remarque :

Les membres privés ne sont pas affichés par JScript IntelliSense. Les membres privés sont dénotés dans ASP.NET AJAX comme des membres qui commencent par un trait de soulignement (_).

Description des erreurs de JScript IntelliSense

Le moteur de JScript IntelliSense dans Visual Studio assure automatiquement la validation en vérifiant les liens de la référence du script et l'exécution préprocesseur. La validation du lien de la référence du script est déterminée selon le contexte de programmation actuel. Si une référence particulière est introuvable, Visual Studio fournit des informations sur l'erreur relative à la référence. Le signalement des erreurs préprocesseur survient en cas d'échec de l'exécution des fichiers dépendants.

Pour plus d'informations sur la façon dont la validation des liens est déterminée, consultez Détermination du contexte IntelliSense. Pour plus d'informations sur la façon dont les erreurs préprocesseur sont déterminées, consultez Traitement des informations IntelliSense.

Appel de validation de JScript

Dans Visual Studio, la validation de JScript IntelliSense est appelée de deux façons :

  • Période d'inactivité. La validation est appelée automatiquement en cas de période d'inactivité dans tout document actif qui contient le script.

  • Manuellement. Vous pouvez également appeler manuellement la validation de JScript IntelliSense. Pour ce faire, dans le menu Edition, cliquez sur Avancé, puis sur Valider le document. Cette commande s'applique à tous les documents ouverts.

Résultats de la validation

Lorsque Visual Studio ne peut pas résoudre les références de script, ou si d'autres types d'erreurs de script empêchent le moteur IntelliSense de collecter des résultats complets à partir de l'actuel contexte de script, Visual Studio fournit des commentaires des façons suivantes :

  • Éléments soulignés dans l'éditeur. Les soulignements rouges ondulés indiquent des erreurs. Si vous maintenez le pointeur de la souris sur l'erreur, une info-bulle affiche la description de l'erreur.

  • Fenêtre Liste d'erreurs. La fenêtre Liste d'erreurs affiche la description de l'erreur, le fichier où l'erreur s'est produite, le numéro de ligne et de numéro de colonne, et le projet. Pour afficher la fenêtre Liste d'erreurs, cliquez sur Liste d'erreurs dans le menu Affichage.

Retour au début

Ressources supplémentaires

Procédure pas à pas : JScript IntelliSense

Comment : créer des commentaires de code XML JScript

Retour au début

Voir aussi

Tâches

Procédure pas à pas : JScript IntelliSense

Assignation dynamique de références de script

Référence

Liste des membres

Autres ressources

Utilisation de la fonctionnalité IntelliSense

About the DHTML Object Model

Objets JScript