Comment documentez-vous votre JavaScript?

Question

J'ai besoin de documenter beaucoup de code JavaScript et jQuery. Je m'intéresse aux diagrammes plutôt qu'à la documentation écrite.

Je me demande s'il existe une sorte de norme pour modélisation les fonctions JavaScript? Mon but est de montrer visuellement comment les différentes fonctions interagissent les unes avec les autres.

Merci

Edit: J'ai essayé des diagrammes DFD et séquence, mais il travaille aussi bien que je le voudrais à. J'ai le choix de mapper les appels de fonction aux processus dans le DFD, mais cela rend le diagramme trop confus et il est plus facile de passer d'un firebug d'une fonction à une autre.

Appeler des processus différemment des noms de fonctions signifie qu'après avoir lu le diagramme, il ne sera pas si facile de le mapper au javascript ... Va poster quelques scerenshots dans un bit.

Answer 1

Il n'y a pas d'outil disponible pour cela, mais selon moi, vous pouvez utiliser pour ce qui est utilisé dans OOD pour montrer le flux entre la fonction appelle ou un diagramme de séquence UML vous pouvez utiliser organigrammes montrer le flux de contrôle.

Remarque: remplacer le nom d'objet avec votre fichier JavaScript

Exemple de diagramme de séquence

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

Answer 2

Si je comprends bien que vous devez faire la documentation pour votre projet/produit, non?

Peut-être que MS Visio pourrait être utile pour vos besoins. C'est un logiciel de documentation qui est utilisé pour créer des diagrammes de flux de données (DFD), etc.,

Peut-être pourriez-vous l'utiliser pour modéliser votre code JavaScript/jQuery. Autant que je sache, ceci est bon pour la documentation.

Essayez ceci ou recherchez des objets similaires.

J'espère que c'est utile.

Il y en a un autre comme ceci, Rational Rose.

Answer 3

Pour les diagrammes de séquence simples, j'ai récemment découvert websequencediagrams.com et c'est génial pour mes besoins. Simple, personnalisable et intégrable. Essayez-le!