良いコードの書き方(for Python)

はじめに

• チーム開発を行う上で個人的に気をつけていることです。
• これを心がけることでプルリクで指摘されることが減ります。（願望）
• 随時、追記＆修正していきたいと思っています。
• 各項目ごとにおすすめの記事などあれば教えていただけると記事の更新の励みになりますのでよろしくお願いします。🙇

良いコードとは？

→少ないコスト（時間・人件費）で要件を実現できる
→要求を効率的に満たす実装を迅速に提供できるコード

コードの可読性：

• ＝他の人が理解しやすいコード
  • 変数
    • 変数名を親が見てもわかる
    • 同じ変数名を使い回されていない
    • 変数名に数字が入っていない
  • docstringがある
  • 機能ごとにファイルやフォルダーが分かれている
  • コードの重複がない
  • マジックナンバーがない(定数化されている)
  • インデントがある(コード間にスペースがある)

拡張性と修正の容易さ：

• =将来の変更や追加がしやすいコード
  • 不要なライブラリを使われていない
  • 使用するライブラリのバージョンが固定されている
  • 同じ処理は1つの関数(もしくはクラス)にまとめて使している
• =精度検証が容易なコード
  • 1つの関数を叩くだけで、1つの機能の精度を確認できる（ex: 検索、分類予測）
    • アウトプットは結果のみを返す(処理時間や入力が返答に含まれない)

実行速度：

• =高速に動作するコード
  • ネストが深くない

正確性：

• =正確な結果を返すコード
  • 戻り値は常に同じデータ型

参考サイト

• チーム開発の生産性が向上する良いコードの書き方：強いエンジニアになるための思考法