開発者が知るべき10のコード可読性Tips
5 分で読了
読みやすいコードはバグを減らし、レビューを速め、保守を容易にします。すぐに実践できる10のTipsを紹介します。
- 適切に命名する: 可読性を決める最大の要因。説明的な名前があればコメントは不要になります。
- 関数を短く保つ: 最大20行。各関数は1つのことだけを行うべきです。
- 言語のスタイルガイドに従う: PythonならPEP 8、JSならAirbnbなど。
- 一貫したフォーマット: フォーマッター(Prettier、Black、gofmt)を使い、タブvsスペースを手作業で議論しない。
- 深いネストを避ける: 早期リターンとガード節でコードをフラットにする。
- コメントは「なぜ」を書き、「何を」は書かない: コードは「何を」を示し、コメントは「なぜ」を説明します。
- 意味のある変数型を使う:
enabled(文字列の可能性)ではなくisEnabled(真偽値)。 - 肯定的な条件を優先する:
if (!isInvalid)ではなくif (isValid)。 - 関連するコードをまとめる: 関連ロジックを近くに置き、空行で関心事を分離する。
- デッドコードを削除する: コメントアウトされたコードはノイズです。代わりにバージョン管理を使いましょう。
コードをフォーマットする
ケース変換ハブで一貫した命名規則を保ちましょう。