Ordnungsgemäße Methode zum Dokumentieren oder Darstellen benutzerdefinierter Ereignismodelle im DOM

Question

Stellen Sie sich vor, Sie haben eine Reihe von Komponenten und Unterkomponenten in Ihrer Webanwendung. Sie möchten verfolgen, wie sich alle hinzugefügten benutzerdefinierten Ereignisse verhalten. Gibt es etablierte Möglichkeiten, diese Verhaltensweisen zu dokumentieren oder zu dokumentieren?

Hier sind einige Dinge, die die Dokumentation zeigen soll:

1. Die eigentliche Verschachtelung der entsprechenden DOM-Elemente der verschiedenen Komponenten.
2. Die Namen der Ereignisse und wo sie ausgelöst werden.
3. Alle Nutzdaten, die an die benutzerdefinierten Ereignisse angehängt sind (z. B. der Inhalt von memo in einem benutzerdefinierten Prototyp-Ereignis.)
4. Die Orte, an denen Ereignisse beobachtet werden.
5. Zeigt an, welche Ereignisse als Reaktion auf andere Ereignisse ausgelöst werden.
6. Wo Ereignisse erlaubt sind zu sprudeln und wo sie gestoppt werden.

Answer 1

Ich habe noch nie von einem etablierten Dokumentationsstandard für Frontends von Webanwendungen gehört.

Da Sie die verschiedenen Aspekte Ihrer Anwendung identifiziert haben, die Sie verfolgen möchten, können Sie diese Informationen für jeden Ereignishandler in einem Docblock speichern und mithilfe der jsdoc toolkit Inline-Dokumente erstellen.

IMHO, ich denke, da Sie wissen, was Sie bereits dokumentieren möchten, sollten Sie Dokumentation in jedem Format erstellen, das für Sie am sinnvollsten ist, auch wenn es für Ihre App/Organisation völlig einzigartig ist. 8 Stunden auf stackoverflow ohne Antworten müssen bedeuten, dass es keine Standardantwort gibt;)

Answer 2

Ehrlich gesagt, ich liebte Visual Modeler, und wenn MS es für Visio abgeladen hatte, war ich etwas enttäuscht.

Das gesagt, Visio ist immer noch ein großartiges Werkzeug, und Sie können es zum Erstellen von Objektmodellen von Komponenten und Definieren von Ereignissen, Eigenschaften, Methoden usw. verwenden. Es hat einige eingebaute Funktionalität für UML-Designs und alle.

Aber ich muss am Ende sagen, ich am Ende mit Notepad oder MS Word enden. Je nachdem, wie ausführlich Sie mit Ihrer Dokumentation sein möchten, passt das Eintippen von Notizen oder eine Beschreibung für eine Komponente nie wirklich in ein DOM-Tool, aber Sie können in einem Word-Dokument wie ein Verrückter fett, tabellarisch, list und kursiv schreiben .

Klingt traurig, aber es ist wahr!