Redux: アプリケーションの状態を文書化する

作成日 2017年01月11日  ·  3コメント  ·  ソース: reduxjs/redux

私はReact / ReduxWebアプリケーションに取り組んでいます。 プロジェクトの開始時に、私は自分のアプリケーションの状態を非常によく理解していました。 しかし、コードベースが大きくなるにつれて、レデューサーを介してアプリケーションの状態に属性を追加する傾向があります。 ここでの問題は、新しい人が私のプロジェクトに参加した場合、その人は州にすでに存在するすべての属性について明確な知識を持っていない可能性があるということです。

現在、 state.jsというファイルでコメントアウトされたオブジェクトを使用して、状態のすべての属性を記述しています。

/*
    APP_STATE = {
        attribute1 : '',
        attribute2 : '',
        attribute3 : [],
        attribute4 : {
            key: ''
        },
    }
*/

問題は、アプリケーションの状態の構造を文書化して、わかりやすくするためのより良い方法はありますか? 皆さんはどのようなアプローチを使用していますか?

最も参考になるコメント

構造にもよりますが、 wp-calypsoはその上で素晴らしい仕事をしていると思います。 それらには、セレクター、レデューサー、定数、アクション、およびほとんどのドキュメントを保持するREADME.mdファイルがあり、それらはすべて同じディレクトリにあります。 以下を見てください!

  product
    reducer.js
    selectors.js
    actions.js
    constants.js
    README.md

それらをチェックしてください!

全てのコメント3件

構造にもよりますが、 wp-calypsoはその上で素晴らしい仕事をしていると思います。 それらには、セレクター、レデューサー、定数、アクション、およびほとんどのドキュメントを保持するREADME.mdファイルがあり、それらはすべて同じディレクトリにあります。 以下を見てください!

  product
    reducer.js
    selectors.js
    actions.js
    constants.js
    README.md

それらをチェックしてください!

@JacobSoderblomそれは興味深いです。 複雑さが軽減された同様のアプローチである可能性があり、構造は小規模なアプリでも機能します。 ありがとう。

redux-devtoolsredux-devtools-extensionなどのReduxdevtoolをいつでも使用して、状態ツリーを参照できます。 また、いつでも状態をJSON.stringifyて(コンソールからアクセスできるように、ストアをwindowに置くことをお勧めします)、どのように見えるかを確認することもできます。

このページは役に立ちましたか?
0 / 5 - 0 評価