IntelliSense JavaScript

Article
06/10/2015

IntelliSense vous aide à écrire du code plus vite et avec moins d'erreurs en fournissant des informations pendant l'écriture du code.Lorsque vous travaillez avec un script client dans l'éditeur JavaScript, IntelliSense répertorie les objets, les fonctions, les propriétés et les paramètres qui sont disponibles en fonction de 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 de la fonction IntelliSense personnalisée avec les commentaires de documentation XML et l'extensibilité JavaScript IntelliSense.

Cette rubrique contient les sections suivantes :

Détermination du contexte IntelliSense
Traitement des informations IntelliSense
Fonctionnalités de JavaScript IntelliSense
Extensibilité JavaScript IntelliSense
Validation JavaScript

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

Détermination du contexte IntelliSense

JavaScript IntelliSense fournit des choix de programmation qui s'appuient sur l'ensemble du script et qui correspondent à votre contexte de script 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.

Votre contexte de script actuel est créé sur la base des éléments suivants :

Fonctions définies dans tous les blocs de script du document actif.Les blocs de script inline sont pris en charge dans les fichiers qui ont les extensions .aspx., .ascx, .master, .html, et .htm.
Éléments script avec des attributs src qui pointent sur un autre fichier de script.Le fichier de script cible doit avoir l'extension de nom de fichier .js.
Fichiers JavaScript qui référencent d'autres fichiers JavaScript à l'aide d'une directive reference.
Groupes de référence pour objets globaux, extensions IntelliSense ou fichiers de script chargés en différé.
Références aux services Web XML.
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 JavaScript IntelliSense, le service de langage effectue les opérations suivantes :

Crée une liste de fichiers JavaScript dépendants basés sur les références contenues dans le document actif et sur 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 service de langage JavaScript, 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.Les scripts sur les magasins distants (tels que ceux référencés à l'aide du protocole HTTP) ne sont pas analysés.

Fonctionnalités de JavaScript IntelliSense

JavaScript 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
Objets définis dans des fichiers externes à l'aide de références, comme des références de script, des directives de référence et des groupes de référence.
Objets définis dans des fichiers distants téléchargés par Visual Studio.
Objets spécifiés dans des commentaires de documentation XML, tels que des paramètres et des champs.
Objets décrits à l'aide de balises de commentaires JavaScript standard (//).Pour plus d'informations, consultez Extension de JavaScript IntelliSense.
Objets pris en charge à l'aide du mécanisme d'extensibilité.Pour plus d'informations, consultez Extension de JavaScript IntelliSense.
Objets ASP.NET AJAX

Si IntelliSense ne parvient pas à déterminer le type d'un objet, il fournit des options pour compléter automatiquement les instructions à l'aide d'identificateurs dans le document actif.Pour plus d'informations, consultez Saisie semi-automatique des instructions pour les identificateurs.

Éléments DOM HTML

JavaScript IntelliSense fournit des références de programmation pour les é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.JavaScript IntelliSense prend en charge également les objets window et document, ainsi que leurs membres.

Objets intrinsèques

JavaScript IntelliSense fournit des références de programmation pour les objets intrinsèques tels que Array, String, Math, Date et Number.Pour plus d'informations sur les objets intrinsèques, consultez Objets intrinsèques (JavaScript).

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

Lorsque vous modifiez un fichier JavaScript, 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 JavaScript IntelliSense.

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

Références de fichiers externes

Vous pouvez inclure divers types de références de fichiers externes pour mettre en place la prise en charge d'IntelliSense dans votre code.Les références de fichiers externes peuvent être des références de script ou des directives de référence, ou elles peuvent être spécifiées à l'aide de groupes de référence.

Références de script

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 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 utilisant l'attribut src dans une balise <script> pour référencer un fichier de script.

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

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" runat="server">
  <Scripts>
    <asp:ScriptReference Path="~/Scripts/JavaScript.js" />
  </Scripts>
</asp:ScriptManager>

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 Embedding a JavaScript File as a Resource in an Assembly.

Directives de référence

Une directive reference permet à Visual Studio d'établir une relation entre le script vous modifiez actuellement et d'autres scripts.La directive reference 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 reference 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.Dans le premier exemple, le service de langage recherche le fichier dans le dossier qui contient le fichier projet (par exemple, .jsproj).

/// <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]

JavaScript IntelliSense n'est pas pris en charge pour le script contenu dans les fichiers de service Web (.asmx) dans 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 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.

Groupes de référence

Vous pouvez utiliser les groupes de référence prédéfinis pour spécifier que des fichiers .js IntelliSense particuliers figurent dans la portée de différents projets JavaScript.Les types de groupe de référence suivants sont disponibles :

Implicite (Windows) pour les applications Windows Store en JavaScript.Les fichiers inclus dans ce groupe figurent dans la portée de chaque fichier .js ouvert dans l'éditeur de code pour le projet du type spécifié.
Implicite (Web) pour les projets HTML5.Les fichiers inclus dans ce groupe figurent dans la portée de chaque fichier .js ouvert dans l'éditeur de code pour ces types de projet.
Groupes de référence de processus de travail dédié pour les traitements Web HTML5.Les fichiers spécifiés dans ce groupe figurent dans la portée des fichiers .js qui possèdent une référence explicite à un groupe de référence de processus de travail dédié.
Générique pour les autres types de projet JavaScript.

Dans la plupart des scénarios, vous ne devez pas modifier les groupes de référence.Toutefois, si vous souhaitez apporter des modifications, vous pouvez utiliser les options de configuration pour l'éditeur de code JavaScript afin de spécifier les fichiers inclus dans les groupes de référence.Pour obtenir des instructions sur l'utilisation de cette fonctionnalité, consultez Options, Éditeur de texte, JavaScript, IntelliSense.

Conseil
Les références IntelliSense sont généralement utilisées pour fournir la prise en charge d'IntelliSense pour les objets globaux et pour les extensions IntelliSense.Vous pouvez également utiliser cette fonctionnalité pour les scripts qui doivent être chargés au moment de l'exécution à l'aide du chargeur de script.

Références de fichiers distants

Vous pouvez demander à Visual Studio de télécharger des fichiers JavaScript distants référencés dans un fichier JavaScript afin d'assurer la prise en charge d'IntelliSense pour la bibliothèque ou le fichier distant.Lorsque vous utilisez cette fonction, les fichiers sont téléchargés lorsque vous les incluez en tant que référence dans votre fichier JavaScript.

[!REMARQUE]

À l'exception des projets Web, cette fonctionnalité fonctionne uniquement pour les fichiers JavaScript ouverts en dehors du contexte d'un projet.Pour les projets Web, les fichiers distants référencés dans votre projet sont téléchargés par défaut.

Pour obtenir des instructions sur l'utilisation de cette fonctionnalité, consultez Options, Éditeur de texte, JavaScript, IntelliSense.

Attention
Si vous activez cette fonctionnalité et que vous observez un ralentissement dans l'éditeur de code, nous vous recommandons de la désactiver.

Commentaires de documentation XML

Les commentaires de documentation XML sont des descriptions textuelles des éléments de code que vous ajoutez au script.Ces descriptions textuelles s'affichent dans IntelliSense lorsque vous référencez le script commenté.Par exemple, vous pouvez fournir des informations sur les paramètres et la valeur de retour d'une fonction.Les commentaires de documentation XML sont disponibles uniquement à partir de fichiers, d'assemblys et de services référencés.Pour plus d'informations, consultez Commentaires de documentation XML (JavaScript) et Comment : créer des commentaires de documentation XML JavaScript.

IntelliSense peut afficher les commentaires de documentation XML dans les scénarios suivants :

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

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

Objets ASP.NET AJAX

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

[!REMARQUE]

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

Extensibilité JavaScript IntelliSense

Le service de langage JavaScript fournit des objets et des fonctions qui vous permettent de modifier l'expérience IntelliSense pour les développeurs qui utilisent des bibliothèques tierces.Ces fonctionnalités sont particulièrement utiles lorsque le service de langage par défaut ne peut pas fournir toutes les informations que vous souhaitez fournir aux clients.Pour plus d'informations, consultez Extension de JavaScript IntelliSense.

Validation JavaScript

La validation de script JavaScript se déroule sans interruption en arrière-plan.Lorsque Visual Studio détecte des erreurs de syntaxe dans le code JavaScript, des commentaires sont fournis de différentes façons :

É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.
La fenêtre Sortie indique les références qui n'ont pas été chargées.

Retour au début

Voir aussi

Partager via