Visual Studio 2010 Javascript/jQuery Documentación

Question

bien, aquí dos cuestiones:

1. ¿Hay algo como GhostDoc de JS?
2. ¿Existen buenos generadores de archivos de ayuda que puedan usar los archivos fuente JS C# y para generar documentación? Parece que SandCastle no admite un sitio web en lugar de un proyecto web con archivos .proj. Y, hasta donde puedo decir, Natural Docs no es compatible con la documentación de estilo de Visual Studio ... así que eso no funcionará.

Siento que me falta algo aquí. Simplemente no puedo creer que la gente comenta su JS a mano ... TIENE que haber algo, ¿verdad?

He buscado alto y bajo. Estoy pidiendo como último recurso. ¡Solo dime que apesta la búsqueda y que hay soluciones fáciles para esto! :-)

Answer 1

Dijiste esto como un ejemplo (Hubiera sido agradable ponerlo en la pregunta adecuada, tal vez un mod vendrá y lo hará por ti, ya que deberías poder editar tus propias preguntas) y desea saber si el bloque /// <summary> se puede insertar automáticamente en la parte javascript del código, no solo en los archivos .cs.

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

lo creo que lo haría, pero acabo de escribir esas cosas tan rápido que no me doy cuenta que estoy escribiendo. Tiendo a hacer los míos manualmente también, pero generalmente no necesito javadoc mi código (no usamos javadocs), así que no sé si hay alguna herramienta automatizada para ayudar con eso en VS. Tenía curiosidad, así que me aferré a esta publicación (de favoritos) para poder ver si alguien más tiene buenas ideas sobre esto.

Answer 2

Puede usar YuiDoc para generar un resultado similar a JavaDoc. Lo he usado y estaba muy contento con la salida que proporciona. Necesita usar su formato para comentarios que no es lo mismo que el formato de Visual Studio.

Answer 3

debe hacer referencia a todos los archivos js serán utilizados en la fuente, añadiendo:

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

parte superior de su archivo javascript. De esta forma, puedes obtener intellisense en javascript.

Una última cosa, algunos marcos js (por ejemplo, jQuery) tienen un archivo -vsdoc.js para intellisense. Debe colocar los archivos donde residen sus archivos js originales; y los nombres de ellos deben ser coincidentes.

si sus archivos js nombre es "Test.js", entonces su archivo -vsdoc debe ser nombrado: "test-vsdoc.js"

Answer 4

¿hay algo en esta lista de utilidad para usted: https://stackoverflow.com/questions/1221413/what-tools-are-available-for-documenting-javascript?