Visual Studio / Javascript : Commentaire d’API dans l’IntelliSense

L’éditeur JavaScript de Visual Studio est un de mes préférés notamment grâce à l’IntelliSense dont j’avais parlé dans un précédent article. Nous allons voir dans ce post comment améliorer l’intelliSense afin de pouvoir voir les paramètres attendu par une fonction JavaScript, sa description, ….

Visual Studio utilise pour JavaScript les commentaires XML comme en C# à la différence que ceux-ci doivent se trouver au début du corps de la fonction et non au dessus.

var exampleFunction = function (a, b, c) {
    /// <summary>Exemple de description d'un fonction</summary>;
    /// <param name="a" type="String">description d'un paramètre de type string</param>
    /// <param name="b" type="int">description d'un paramètre de type int</param>
    /// <param name="c" type="Object">description d'un paramètre de type Objet</param>
    ... ici le code de la fonction
}

Sans et avec commentaires de fonction :
VS2012-FunctionWithOutComment

VS2012 - Fonction avec Commentaire

Par défaut, malheureusement, Visual Studio ne génère pas automatiquement le squelette des commentaires lors de l’insertion de ///. Il existe cependant des extensions qui permettent de le faire :

L’IntelliSense peut afficher les commentaires dans les scénarios suivants :

  • 1 fichier .js référence un auter fichier .js .
  • 1 fichier .js référence 1 fichier .aspx ou cshtml.
  • 1 fichier .aspx ou .cshtml qui référence 1 fichier .js.

L’IntelliSense n’est pas disponible quand un fichier .aspx (ou .cshtml) référence un autre fichier.aspx (ou .cshtml).

Il existe une version de JQuery avec les commentaires compatible avec VS dont j’avais parlé dans un précédent article concernant les astuces JQuery.

Il faut savoir qu’il existe une autre norme pour les commentaires API en JavaScript JsDoc et que Web Essentials 2012 permet de gérer.

Références

Bon codage !!

Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *