勉強会 – 開発チームで共有・学んだこと

開発チームで定期的に勉強会を開いています。
メンバーがブログに書いている題材(リーダブルコード)と重複しますが、
皆でコードに対しての考え方を共有したことです。

大前提として目指すところ
・コードは理解しやすくなければいけない

【1・理解しやすいコード】

読みやすさの基本定理として、鍵となる考え方
・コードは他の人が最短時間で理解できるように書かなければいけない。

自分が書きたいようにコードを書くのではなく、常に「他の人が読んでも理解しやすいか」
ということを意識として持ちながらコードを書いていきたい。

また、前提としてコードは行も長さも短いに越したことはない。
ただし、コードがある程度長くなっても最優先事項として「理解するまでにかかる時間」を
短くする方が大切だということを共有しました。

コードを見たらすぐにリファクタリングしたくなる人がいるけども、
そこを一歩下がって「このコードは理解しやすいだろうか」と自問自答してみることが大切
※自分がわかりやすいからと他の人がわかりやすいは別。要領とシンプルイズベストを目指したい

■ 表面上の改善
コードの表面上をキレイにする意識をするだけでも改善ができる

・コードの変数などに適切な名前を付ける
・優れたコメントを記載する
・空白の使い方をキレイにする

これらだけでもコードはもっと読みやすくなる

■ 名前に情報を詰め込む

これ難しい。。名前を付けるときはいっぱいある。

・変数
・関数
・ファイル
・クラス
他

名前は短いコメントだと考える。
〇名前に情報を詰め込むことを意識しましょう

プログラムに使われる名前はハッキリしないものが多い。
例えば

tmp → 何が一時的に入ってる？
size → 何に対するサイズ？単位は？
get → 何の取得？それかリクエスト？

以下が名前を決める際に意識したいこと

・明確な単語を選ぶ
・汎用的な名前を避ける(あるいは使う状況を選ぶ)
・抽象的な名前よりも具体的な名前を使う
・接尾辞や接頭辞を使って情報を追加する → 分類的に使う場合多い
・名前の長さを決める → 3つ以上はつらいかも
・名前のフォーマットで情報を伝える

以上、勉強内容でした！！