11
votes

Y a-t-il un outil pour commenter le code JavaScript?

Y a-t-il un outil de commentaire JavaScript car il est en C # comme Ghost Doc. xxx pré>

là n'importe quel outil pour ajouter automatiquement les commentaires comme ci-dessus. Comme dans C # Code Ghost DOC a fait: P>

/// <summary>
///   Method to calculate distance between two points
/// </summary>
/// <param name="pointA">First point</param>
/// <param name="pointB">Second point</param>
private void calculatePointDistance(pointA, pointB)
{
  .....
}

javascript visual-studio comments

1 commentaires

Sur le blog Ghostdoc, il y a une réponse directe du membre de l'équipe qu'ils ne prévoient pas et ne prévoient pas de soutenir JavaScript. Quoi qu'il en soit, Autodocumenttig est mal, vous mettez de mieux à mettre un effort manuel pour rendre votre code documenté

6 Réponses :

7
votes

Oui (mais plus comme Javadoc) - Regardez JSDOC Fondamentalement, vous utilisez une syntaxe spéciale de type Javadoc dans vos commentaires par ex. @param code> Comme dans l'exemple suivant, puis l'analyseur génère une bonne sortie HTML pour vous

/**
* Shape is an abstract base class. It is defined simply
* to have something to inherit from for geometric 
* subclasses
* @constructor
*/
function Shape(color){
    this.color = color;
}

3 commentaires

Il est après un plugin Visual Studio qui permettrait d'automatiser la création de la documentation XML. Ghostdoc crée des talons de documentation afin de ne pas avoir à écrire tout seul. (-1 de moi) ...

Et quel est ton point? Si vous lisez mon commentaire - Ghostdoc ne le fera pas pour lui - alors je fournis au gars une alternative précieuse. Ou tu viens de l'apprécier?

Il est après une tierce partie addin qui fonctionnerait de la même manière à Ghostdoc mais pour JavaScript. Ghostdoc ne soutiendra pas JS en premier lieu qui ne signifie pas que quelqu'un d'autre ne le fera pas. L'idée est d'obtenir une addition qui ajoute une documentation XML pour JavaScript afin que nous ne disposons pas de taper manuellement dans tous les éléments XML, mais plutôt de leurs valeurs (et des types).

0
votes

Je ne l'ai pas utilisé personnellement, mais JSDOC-Toolkit semble Soyez ce que vous êtes après.

0 commentaires

2
votes

La réponse courte est non, rien qui automatise la documentation. La fermeture que vous obtenez est d'ajouter manuellement des commentaires avec quelque chose comme JSDOC-TOOLKIT qui permet de construire la documentation dans les pages HTML.

Il y a une documentation IntelliSense pour JavaScript pour JavaScript pour JavaScript, qui ressemble à ceci (remarquez-le à l'intérieur de la fonction) P>

function example(var myParameter){
    /// <summary>This is an example function</summary>
    /// <param name="myParameter" type="String">All your string are belong to us.</param>
    /// <returns type="Boolean" />

   return !!myParameter;
}

2 commentaires

JavaScript n'a pas de paramètres dactylographiés ...

Était juste une faute de frappe, corrigé la signature de la méthode

0
votes

Je ne l'ai pas utilisé pour JavaScript, mais DOXYGEN a un filtre qui le permet (au moins dans une certaine mesure) être utilisé pour documenter JavaScript. Il peut être intéressant de rechercher, surtout si vous utilisez d'autres langues aussi prises en charge par Doxygen, vous pouvez donc avoir un outil pour tout.

Il semble que Jsunit utilise Doxygen pour sa documentation.

1 commentaires

Ya, j'ai essayé ça mais je n'ai jamais eu ce filtre pour travailler :(

0
votes

Sandcastle semble prendre en charge JavaScript aussi, voir http://blogs.msdn.com/sandcastle/archive/2007/06/28/scriptdoc-1-0-for- Extractiong-JavaScript-Code-Code-Comments-is-Now--Disponible-At-Codeplex.aspx . Je l'utilise pour C # puisque le projet NDoc est Toast, mais je n'ai pas encore essayé pour JavaScript. J'avais l'habitude d'utiliser JSDoc mentionné ci-dessus.

0 commentaires

1
votes

Je me demande pourquoi personne n'a mentionné Docstubsjs

0 commentaires