Ich arbeite an einer React / Redux Webanwendung. Zu Beginn des Projekts hatte ich ein sehr gutes Verständnis für meinen Bewerbungsstand. Aber wenn die Codebasis wächst, neige ich dazu, dem Anwendungszustand durch Reduzierer immer mehr Attribute zuzuordnen. Das Problem dabei ist, dass wenn eine neue Person in mein Projekt einsteigt, sie möglicherweise nicht alle Attribute kennt, die bereits im Staat vorhanden sind.
Im Moment verwende ich nur ein auskommentiertes Objekt in einer Datei namens state.js
, um alle Attribute im Zustand zu beschreiben.
/*
APP_STATE = {
attribute1 : '',
attribute2 : '',
attribute3 : [],
attribute4 : {
key: ''
},
}
*/
Die Frage ist: Gibt es eine bessere Möglichkeit, den Aufbau meines Bewerbungsstandes so zu dokumentieren, dass er leicht nachvollziehbar ist? Welchen Ansatz verwenden Sie?
Abhängig von Ihrer Struktur, denke ich, dass wp-calypso diesbezüglich hervorragende Arbeit leistet. Sie haben Selektoren, Reduzierer, Konstanten, Aktionen und eine README.md-Datei, die den größten Teil der Dokumentation enthält, alle im selben Verzeichnis. Schauen Sie unten!
product
reducer.js
selectors.js
actions.js
constants.js
README.md
Schau sie dir an!
@JacobSoderblom das ist interessant. Möglicherweise funktioniert ein ähnlicher Ansatz mit reduzierter Komplexität und Struktur für kleine Apps. Vielen Dank.
Sie können jederzeit ein Redux-Devtool verwenden, z. B. entweder redux-devtools oder redux-devtools-extension, um den Zustandsbaum zu durchsuchen. Sie können auch jederzeit JSON.stringify
den Status anzeigen (ich schlage vor, den Store auf window
zu setzen, um ihn über Ihre Konsole zugänglich zu machen), um zu sehen, wie er aussieht.
Hilfreichster Kommentar
Abhängig von Ihrer Struktur, denke ich, dass wp-calypso diesbezüglich hervorragende Arbeit leistet. Sie haben Selektoren, Reduzierer, Konstanten, Aktionen und eine README.md-Datei, die den größten Teil der Dokumentation enthält, alle im selben Verzeichnis. Schauen Sie unten!
Schau sie dir an!