初めに
今回は変数名や、layout
のid
などを命名する時に絶対にやめたほうがいいことを紹介していきます。
本文
まず初めが別画面で同名のidを使わないといことです。
最近はJetpack Compose
が出て来たのもあって今後減っていきそうではありますが、命名するのが難しいViewがある場合に汎用的すぎる名前をつけているのが時々見受けられます。
汎用的なIDをつける場合はせめてどの画面のものなのかがわかるようにしたりしましょう。
次が関数名をつける時は動詞を前に持ってくるです。
初心者や新入社員の方に多くみられるのが動詞が後ろの方に来てしまってることがありますが、それだと該当の関数が何をするのかがぱっと見でわかりません。
例としてsetupPageView
とかけば見る側は少なからず何かしらのセットアップをすることがわかりますが、pageViewSetup
だとPageViewに対して何かをすることしかわかりません。
もちろん対象は大事ですが、ある程度の知見がある人の場合何をしたいのかが重要で中身のコードを見れば対象がなんなのかは大抵わかります。
そのため、まずは何をしたい関数なのかをはっきりさせておくと他の人が見た時に親切になります。
最後に
あまり考えたことがない人もいるかと思いますが、これを意識するだけでレビューで修正依頼をされる回数も減るかと思いますので、是非一度確認をしつつ実装をしてみてください。