2012-04-16 14 views
5

¿Existe una herramienta que hay que genera un HTML de documentación de JavaScript genérico que se documenta en VSDoc sintaxis (ninguna sintaxis similar a javadoc!)?JavaScript Documentación de VSDoc

No hay posibilidad de cambiar a una sintaxis similar a JavaDoc, porque estamos escribiendo JS en Visual Studio y VS solo admite comentarios de VSDoc para JS.

Para MS ASP.NET AJAX es una herramienta disponible, pero no está funcionando con JS genérico.

Ejemplo:

$m = { 
    registerControlType: function(controlPrototype, baseControlType) { 
     /// <summary> 
     /// Summary 1 
     /// </summary> 
     /// <param name="controlPrototype" type="Object"> 
     /// Param 1 
     /// </param> 
     /// <param name="baseControlType" type="String" optional="true"> 
     /// Param 2 
     /// </param> 
    }, 

    requestData: function(control, success, failure, postData, plainResponse, maximumSecondsToCache) { 
     /// <summary> 
     /// Summary 2 
     /// <para></para> 
     /// <para>Additional Signatures:</para> 
     /// <para>1. requestData(control, success, [failure], [plainResponse], [maximumSecondsToCache])</para> 
     /// <para>2. requestData(control, success, [postData], [plainResponse], [maximumSecondsToCache])</para> 
     /// <para>3. requestData(control, success, [plainResponse], [maximumSecondsToCache])</para> 
     /// <para>4. requestData(object)</para> 
     /// </summary> 
     /// <param name="control" type="object"> 
     /// Param 1 
     /// </param> 
     /// <param name="success" type="Function"> 
     /// Param 2 
     /// </param> 
     /// <param name="failure" type="Function" optional="true"> 
     /// Param 3 
     /// </param> 
     /// <param name="postData" type="object" optional="true"> 
     /// Param 4 
     /// </param> 
     /// <param name="plainResponse" type="boolean" optional="true"> 
     /// Param 5 
     /// </param> 
     /// <param name="maximumSecondsToCache" type="Number" optional="true"> 
     /// Param 6 
     /// </param> 
    } 
}; 

Respuesta

0

Sólo tiene que incluir su archivo JavaScript como referencia a la parte superior en el archivo y obtendrá IntelliSense.

/// <reference path="path-to/your-script.js" /> 

Importante: Declaraciones de referencias deben preceder a todos los demás contenidos en los comentarios de archivos, incluso normal.

Para la comprobación automática de creación: jsdoc Toolkit (http://code.google.com/p/jsdoc-toolkit/)

ACTUALIZACIÓN:

Tal vez usted puede utilizar YUI Doc (http://developer.yahoo.com/yui/yuidoc/)

Saludos.

+2

Lea mi pregunta nuevamente por favor. No estoy pidiendo inteligencia. Quiero una herramienta para generar documentación HTML de VSDoc commentada JS-Source –

+0

Lo siento. Por lo que sé, necesitarás hacerte tu propio analizador para eso. Probablemente no sea tan difícil de hacer, tal vez un nuevo proyecto github/codeplex? –

+0

actualizó mi respuesta –

Cuestiones relacionadas