2023-07-30 ソースコードのコロケーション
コロケーションを簡単に説明すると、関連するリソース同士を近くに置いておく、という考え方です。
Web フロントエンドにおけるコロケーション (co-location) という考え方について - mizdra’s blog
上ブログより引用。
FooComponent.tsx
と同じディレクトリにFooComponent.test.tsx
を置くsrc/in/deep/directory/FooComponent.tsx
とtest/in/deep/directory/FooComponent.tsx
を行ったり来たりする手間から開放されます
- API ドキュメントは API.md に書くのではなく、コードの中にドキュメンテーションコメントとして書く → API ドキュメントはドキュメンテーションコメントから自動生成する