¿Cómo documenta su JavaScript?

Question

Necesito documentar bastante código JavaScript y jQuery. Me interesan los diagramas, en lugar de la documentación escrita.

Me pregunto si hay algún tipo de estándar para modelado las funciones de JavaScript? Mi objetivo es mostrar visualmente cómo las diferentes funciones interactúan entre sí.

Gracias

Editar: He estado tratando DFDs y diagramas de secuencia, pero está funcionando tan bien como me gustaría que lo haga. Tengo la opción de mapear las llamadas de función a los procesos en el DFD, pero eso hace que el diagrama sea demasiado confuso y es más fácil pasar por un Firebug saltando de una función a otra.

Llamar a los procesos de forma diferente a los nombres de las funciones significa que después de leer el diagrama no será tan fácil mapearlo en el javascript ... Publicaré algunas scerenshots en un momento.

Answer 1

No hay ninguna herramienta disponible para esto, pero en mi opinión se puede utilizar un diagrama de secuencia UML para este que se utiliza en OOD para mostrar el flujo entre las llamadas de función o se puede utilizar diagramas de flujo para mostrar el flujo de control.

Nota: sustituir el nombre del objeto con el archivo JavaScript

Ejemplo de diagrama de secuencia

alt text http://click.sourceforge.net/images/get-sequence-diagram.png

Answer 2

Si he entendido bien lo que necesita que la documentación para su proyecto/producto, ¿verdad?

Tal vez MS Visio podría ser útil para sus necesidades. Es un software de documentación que se usa para crear diagramas de flujo de datos (DFD), etc.,

Quizás podría usar esto para modelar su código JavaScript/jQuery.

Por lo que sé, esto es bueno para la documentación.

Pruebe esto o busque cosas similares.

Espero que sea útil.

Hay otro tipo de esto, Rational Rose.

Answer 3

Para diagramas de secuencia simples, descubrí recientemente websequencediagrams.com y es genial para mis necesidades. Simple, personalizable e incrustable. ¡Intentalo!