Come documentate il vostro JavaScript?

Question

Ho bisogno di documentare un bel po 'di codice JavaScript e jQuery. Sono interessato ai diagrammi, piuttosto che alla documentazione scritta.

Mi chiedo se esiste una sorta di standard per la modellazione delle funzioni JavaScript? Il mio obiettivo è mostrare visivamente come le diverse funzioni interagiscano tra loro.

Grazie

Edit: Ho cercato DFDS e diagrammi di sequenza, ma sta funzionando così come mi piacerebbe che. Ho una scelta di mappare le chiamate di funzione ai processi nel DFD, ma questo rende il diagramma troppo confuso ed è più facile passare attraverso un firebug che salta da una funzione all'altra.

Chiamare i processi in modo diverso rispetto ai nomi delle funzioni significa che dopo aver letto il diagramma non sarà così facile mapparlo al javascript ... Inserirà pochi scerenshots in un po '.

Answer 1

Non esiste uno strumento a disposizione per questo, ma secondo me è possibile utilizzare un diagramma di sequenza UML per questo che viene utilizzato in OOD per mostrare il flusso tra chiamate di funzione oppure è possibile utilizzare diagrammi di flusso per mostrare il flusso di controllo.

Nota: sostituire il nome di oggetto con il vostro file JavaScript

Esempio di schema di sequenza

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

Answer 2

Se ho ben capito il necessario per rendere la documentazione per il progetto/prodotto, giusto?

Forse MS Visio potrebbe essere utile per le vostre esigenze. È un software di documentazione che viene utilizzato per creare diagrammi di flusso di dati (DFD), ecc.,

Forse potresti usarlo per modellare il codice JavaScript/jQuery.

Per quanto ne so, questo è valido per la documentazione.

Provalo o cerca oggetti simili.

Spero sia utile.

C'è un altro come questo, Rational Rose.

Answer 3

Per semplici diagrammi di sequenza, ho scoperto di recente websequencediagrams.com ed è perfetto per le mie esigenze. Semplice, personalizzabile e integrabile. Provalo!