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 skizzieren oder zu dokumentieren?
Hier sind einige Dinge, die die Dokumentation zeigen sollte:
memo in einem benutzerdefinierten Prototype-Ereignis.) 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 in einem Docblock für jeden Ereignishandler speichern und den jsdoc toolkit , um einige Inline-Dokumente zu erstellen.
IMHO, ich denke, da Sie wissen, was Sie bereits dokumentieren möchten, sollten Sie Dokumentation in jedem Format erstellen können, das für Sie am sinnvollsten ist, auch wenn es für Ihre App / Organisation völlig einzigartig ist. 8 Stunden Stackoverflow ohne Antworten bedeutet, dass es keine Standardantwort gibt;)
Ehrlich gesagt liebte ich den visuellen Modellierer, und als MS ihn für Visio abwarf, war ich etwas enttäuscht.
Das heißt, Visio ist immer noch ein großartiges Werkzeug, und Sie können es verwenden, um Objektmodelle von Komponenten zu erstellen und Ereignisse, Eigenschaften, Methoden usw. zu definieren. Es hat einige eingebaute Funktionen für UML-Designs und alle.
Aber ich muss am Ende sagen, dass ich am Ende mit Notizblock oder MS-Word enden werde. 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 formatieren, tabellieren, auflisten und kursiv formatieren.
Klingt traurig, aber es stimmt!
Tags und Links javascript diagram javascript-events