tablas - obtener datos de una tabla html javascript

Generando documentación de Javascript

Question

Estoy buscando una manera de generar documentación automáticamente desde mi proyecto de Javascript . Alguien sabe como puedo hacer esto?

Por lo que sé, hay algunas herramientas como JSDoc pero quiero saber tu opinión, tu mejor opción y por qué.

¡Gracias!

EDIT: solo para ser claro, necesito algo como JavaDOC o PHPDocumentor pero para usar con mi código fuente de Javascript.

Answer 1

¿Qué marco está utilizando? (Si alguna). Creo que la herramienta que elegirás depende mucho de eso, ya que idealmente tendría que entender las extensiones de clase y todo. De lo contrario, creo que jsDoc es un gran lugar para comenzar.

Answer 2

Encontré un gran tutorial para crear documentación JS usando JSDoc. Espero que ayude a alguien que lo necesite.

Cree documentación relevante de Javascript con JSDoc

Esto fue exactamente lo que necesito. Gracias por tus respuestas apiladores.

Answer 3

Hay herramientas como Natural Docs para hacer esto. Personalmente lo he usado en el pasado y esto funciona bien con javascript.

También hay herramientas como docco para documentar el código fuente.

En general, la documentación generada automáticamente tiende a ser demasiado restrictiva y, en ocasiones, las API hechas a mano como la API jQuery son más fáciles de usar.

También la documentación para idiomas dinámicos es diferente de la documentación en lenguajes estáticos. Como las API se utilizan de manera diferente y el estado existe en un sentido más general.

Answer 4

Hola, acabo de encontrar YUIDoc . No sé mucho sobre eso, pero se ve bien ...

Answer 5

Si trabajas con node.js, creé un módulo que genera un diagrama de clase para javascript / node / html / css. Está basado en la extensión "WAE" de UML. Se llama wavi. Para javascript, la función, la variable y el uso de otros módulos se reconocen automáticamente. Puedes usarlo para documentar tu aplicación.

https://www.npmjs.org/package/wavi

Answer 6

SmartComments + YUIDocs

Usando esa extraordinaria pareja puedes documentar un gran proyecto de JavaScript en menos de un minuto.

SmartComments, es una herramienta que le permite crear comentarios implícitos a partir del código fuente de JavaScript.

Puede utilizarlo en la consola o mediante un complemento de texto sublime.

Por favor, vaya a SmartComments para obtener más información.

Answer 7

autodoc es la droga; https://www.npmjs.org/package/autodoc | https://github.com/dtao/autodoc

Autodoc le permite escribir pruebas en comentarios justo por encima de las funciones de JavaScript, luego ejecutar esas pruebas desde la línea de comandos y generar automáticamente la documentación con las mismas pruebas incrustadas y ejecutándose directamente en el navegador.

Piensa en programación alfabetizada, visita http://danieltao.com/lazy.js/docs/ para ver un buen ejemplo. Esas marcas de verificación verdes son las pruebas.

✓ Lazy([1, 2, 4])       // instanceof Lazy.ArrayLikeSequence
✓ Lazy({ foo: "bar" })  // instanceof Lazy.ObjectLikeSequence
✓ Lazy("hello, world!") // instanceof Lazy.StringLikeSequence
✓ Lazy()                // sequence: []
✓ Lazy(null)            // sequence: []

Esto es lo que parece la fuente github.com/../lazy.js#L86

/**
 * Wraps an object and returns a {@link Sequence}. For `null` or `undefined`,
 * simply returns an empty sequence (see {@link Lazy.strict} for a stricter
 * implementation).
 *
 * - For **arrays**, Lazy will create a sequence comprising the elements in
 *   the array (an {@link ArrayLikeSequence}).
 * - For **objects**, Lazy will create a sequence of key/value pairs
 *   (an {@link ObjectLikeSequence}).
 * - For **strings**, Lazy will create a sequence of characters (a
 *   {@link StringLikeSequence}).
 *
 * @public
 * @param {Array|Object|string} source An array, object, or string to wrap.
 * @returns {Sequence} The wrapped lazy object.
 *
 *
 * @examples
 * Lazy([1, 2, 4])       // instanceof Lazy.ArrayLikeSequence
 * Lazy({ foo: "bar" })  // instanceof Lazy.ObjectLikeSequence
 * Lazy("hello, world!") // instanceof Lazy.StringLikeSequence
 * Lazy()                // sequence: []
 * Lazy(null)            // sequence: []
 */

Se extiende a JSDoc https://developers.google.com/closure/compiler/docs/js-for-compiler , para que además pueda tener el compilador de cierre de Google verificando y optimizando muchas cosas para usted.