📖
[typescript] インターフェース管理
概要
- typescriptを書くときに度々ぶつかるインターフェース複雑・煩雑・管理できない問題
- 良いやり方の模索
参考資料
- How to organize TypeScript interfaces [closed]
- TypeScript | Organizing and Storing Types and Interfaces
ファイル名
- types.tsにすると結局わかりやすい
- 具体名.tsにすることもあったが、結局モジュールなのかコンポーネントなのかなんなのかわからなくなるから
共通的な接頭辞を意識する
- ただでさえ読む量が多くなるのでinterface名の接頭辞は関連するのもの同士で合わせた方がいい
悪い例
export interface TagSearch {}
export interface LayoutItem {}
良い例
export interface TagSearch {}
export interface TagItem {}
- 読んでいて共有しているところ(上記の例だと
Tag)は「読まなくていい箇所」として注意から外すことができる - これによって長くなりがちなinterfaceであっても読みやすさを向上できる
コメント
- コメントはやっぱりなんだかんだあると助かる
/**
* Tag Search
*/
export interface TagSearch {}
export interface TagItem {}
よく使う単語
- よく使う単語もおさえておく
- 参考
- Response, Request
- Query
- Information
- Status
- Result
- Log
- Module
- Path
など
Discussion