Visual Studio 2010 Javascript/jQuery Documentation

Question

OKay, deux questions ici:

1. Y at-il quelque chose comme GhostDoc pour JS?
2. Y a-t-il des bons générateurs de fichiers d'aide qui peut utiliser à la fois C# ET fichiers source JS pour générer la documentation? Il semble que SandCastle ne supporte pas un site web, contrairement à un projet web avec des fichiers .proj. Et, pour autant que je sache, Natural Docs ne prend pas en charge la documentation de style de Visual Studio ... cela ne fonctionnera donc pas.

Je me sens comme si je manque quelque chose ici. Je ne peux juste pas croire que les gens là-bas commentent leur JS à la main ... il doit y avoir quelque chose, non?

J'ai cherché haut et bas. Je demande en dernier recours. S'il vous plaît dites-moi juste que je pue à la recherche et qu'il existe des solutions faciles à cela! :-)

Answer 1

Vous avez donné ceci comme un exemple (aurait été agréable de le mettre dans la question appropriée, peut-être un mod passera et le fera pour vous, puisque vous devriez pouvoir éditer vos propres questions) et vous voulez savoir si le bloc /// <summary> peut être automatiquement inséré dans la partie javascript du code, et pas seulement dans les fichiers .cs.

(function ($) { $.fn.helpfulTips = function (options) { 
    /// <summary> 
    /// Helpful Tips 
    /// </summary> 
    /// <param name="options">options</param> 
    /// <returns>jQuery</returns> 
    var defaults = { pointer: "#theArrow" }; 
    } 
}); 

Je pense que ce serait, mais je tapez simplement ce genre de choses si vite que je ne réalise pas que je suis taper. J'ai aussi tendance à faire le mien manuellement, mais je n'ai généralement pas besoin de javadocer mon code (nous n'utilisons pas javadocs), donc je ne sais pas s'il y a des outils automatisés pour ça avec VS. J'étais curieux alors je suis accroché sur ce post (favorisé) donc je peux voir si quelqu'un d'autre a de bonnes pensées à ce sujet.

Answer 2

Vous pouvez utiliser YuiDoc pour générer une JavaDoc comme sortie. Je l'ai utilisé et était très s'il vous plaît avec la sortie qu'il fournit. Vous devez utiliser leur format pour les commentaires qui n'est pas le même que le format Visual Studio.

Answer 3

Vous devez faire référence à tous les fichiers js seront utilisés dans la source en ajoutant:

/// <reference path="jquery-1.4.2.min.js" /> 
/// <reference path="facebox.js" /> 

haut de votre fichier javascript. De cette façon, vous pouvez obtenir intellisense en javascript.

Une dernière chose, certains cadres de js (par exemple.) Ont jQuery un fichier -vsdoc.js pour IntelliSense. Vous devez placer les fichiers où résident vos fichiers js d'origine; et les noms d'entre eux doivent correspondre.

si votre nom de fichiers js est « test.js » alors votre fichier -vsdoc doit être appelé: « test-vsdoc.js »

Answer 4

Y at-il sur cette liste d'utilisation pour vous: https://stackoverflow.com/questions/1221413/what-tools-are-available-for-documenting-javascript?