¿Hay alguna herramienta para comentar el código de JavaScript?

Question

¿Hay alguna herramienta para javascript comentando como está en C# como ghost doc.

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

hay alguna herramienta para agregar automáticamente los comentarios como los de arriba. como en C# código fantasma doc hicieron:

/// <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) 
{ 
    ..... 
} 

quiero hacer lo similar en el lado del cliente, JavaScript

Answer 1

Sí (pero más como Javadoc) - look at JSDoc Básicamente utiliza una sintaxis especial Javadoc-como en sus comentarios, por ejemplo, @param como en el ejemplo siguiente y luego analizador generará guapo salida HTML para usted

/** 
* 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; 
} 

Answer 2

No he utilizado personalmente, pero jsdoc-toolkit parece ser lo que está buscando.

Answer 3

La respuesta corta es no, no hay nada que automatice la documentación. Los cierres que recibe son agregar comentarios manualmente con algo como jsdoc-toolkit que permite construir la documentación en páginas html.

hay documentación IntelliSense para JavaScript JavaScript, así, que se parece a esto (nótese que es dentro de la función, aunque)

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; 
} 

También puede crear fragmentos de archivos javascript. Simplemente crearía algunos fragmentos rellenando documentos comunes (de cualquier tipo que prefiera) y luego simplemente escriba el fragmento y completará la mayoría de la documentación por usted.

Answer 4

No lo he usado para JavaScript, pero Doxygen has a filter lo permite (al menos en cierta medida) para documentar JavaScript. Puede valer la pena investigarlo, especialmente si está utilizando otros idiomas que también son compatibles con Doxygen, por lo que puede tener una herramienta para todo.

Parece que JSUnit usa Doxygen para su documentación.

Answer 5

Sandcastle parece ser compatible con JavaScript también, consulte http://blogs.msdn.com/sandcastle/archive/2007/06/28/scriptdoc-1-0-for-extractiong-javascript-code-comments-is-now-available-at-codeplex.aspx. Lo uso para C# ya que el proyecto NDoc es muy útil, pero aún no lo he probado para JavaScript. Solía ​​usar JSDoc mencionado anteriormente.

Answer 6

Me pregunto por qué nadie mencionó DocStubsJS