Redux: Mendokumentasikan status aplikasi

Dibuat pada 11 Jan 2017 · 3Komentar · Sumber: reduxjs/redux

Saya sedang mengerjakan aplikasi web React / Redux. Pada awal proyek, saya memiliki pemahaman yang sangat baik tentang status aplikasi saya. Namun, seiring bertambahnya basis kode, saya cenderung memasukkan lebih banyak atribut ke status aplikasi melalui reduksi. Masalahnya di sini adalah, jika orang baru bergabung dengan proyek saya, dia mungkin tidak memiliki pengetahuan yang jelas tentang semua atribut yang sudah ada di negara bagian.

Saat ini, saya hanya menggunakan Objek yang dikomentari dalam file bernama state.js untuk menggambarkan semua atribut di negara bagian.

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

Pertanyaannya adalah: Apakah ada cara yang lebih baik untuk mendokumentasikan struktur status aplikasi saya sehingga mudah masuk akal? Pendekatan apa yang kalian gunakan?

Sumber

vraa

👍6

Komentar yang paling membantu

Bergantung pada struktur Anda, saya pikir wp-calypso melakukan pekerjaan yang bagus untuk itu. Mereka memiliki pemilih, reduksi, konstanta, tindakan, dan file README.md yang menyimpan sebagian besar dokumentasi, semuanya dalam direktori yang sama. Lihat ke bawah!

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

Periksa mereka!

JacobSoderblom pada 17 Jan 2017

👍3

Semua 3 komentar

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

Periksa mereka!

JacobSoderblom pada 17 Jan 2017

👍3

@JacobSoderblom itu menarik. Mungkin pendekatan serupa dengan kompleksitas dan struktur yang berkurang akan berfungsi untuk aplikasi skala kecil. Terima kasih.

vraa pada 17 Jan 2017

Anda selalu dapat menggunakan devtool Redux, seperti redux -devtools atau redux-devtools-extension untuk menelusuri pohon status. Anda juga dapat hanya JSON.stringify status kapan saja (saya sarankan meletakkan toko di window untuk membuatnya dapat diakses melalui konsol Anda) untuk melihat seperti apa tampilannya.