Modo corretto di documentare o diagrammare modelli di eventi personalizzati nel DOM

Question

Immagina di avere un sacco di componenti e sottocomponenti nella tua applicazione web. Vuoi tenere traccia di come si comportano tutti gli eventi personalizzati che hai aggiunto. Esistono modi stabiliti per diagrammare o documentare questi comportamenti?

Ecco alcune cose la documentazione deve mostrare:

1. L'attuale nidificazione di elementi DOM rilevanti dei vari componenti.
2. I nomi degli eventi e da dove vengono sparati.
3. Eventuali payload allegati agli eventi personalizzati (ad esempio il contenuto di memo in un evento Prototype personalizzato.)
4. I luoghi in cui vengono osservati gli eventi.
5. Indicazioni su quali eventi vengono generati in risposta ad altri eventi.
6. Dove gli eventi sono autorizzati a bolla e dove sono fermati.

Answer 1

Non ho mai sentito di uno standard di documentazione stabilito per front-end di applicazioni Web.

Detto questo, poiché hai identificato i diversi aspetti della tua applicazione che desideri monitorare, puoi conservare queste informazioni in un docblock per ogni gestore di eventi e utilizzare lo jsdoc toolkit per generare alcuni documenti in linea.

IMHO, penso che dal momento che sai già cosa vuoi documentare, dovresti sentirti libero di creare documentazione in qualsiasi formato abbia più senso per te, anche se è completamente unico per la tua app/organizzazione. 8 ore su stackoverflow senza risposta significa che non esiste una risposta standard;)

Answer 2

Onestamente ho usato AMORE modellatore visivo, e quando MS l'ha scaricato per Visio ero un po 'deluso.

Detto questo, Visio è ancora un ottimo strumento e può essere utilizzato per creare modelli di oggetti di componenti e definire eventi, proprietà, metodi, ecc. Ha alcune funzionalità incorporate per i progetti UML e tutto.

Ma alla fine devo dire che di solito finisco con il blocco note o la parola MS. A seconda di quanto verboso vuoi essere con la tua documentazione, la digitazione di note o una descrizione per un componente non si adatta mai bene a nessun tipo di strumento DOM, ma puoi evidenziare in grassetto, tab, list e corsivo come un pazzo all'interno di un documento Word .

Suoni tristi, ma è vero!