コーディング規約とPEP8

コーディング規約

コーディング規約とは、コードの書き方をまとめたガイドです。同じプログラミング言語を使った場合も、人によってコードの書き方は異なります。複数人でコードを書いていると、お互いに書いたコードをチェックする時に以下のような場面に遭遇します

  • 自分の書き方と違うので、コードの正しさをチェックする以前に、コードを理解するまでに時間が掛かる
  • コードの書き方がバラバラだと、後から修正したい時に、修正箇所を把握するのに時間が掛かる
  • 修正をしやすくするために、コードの書き方を後から整理しようとするととても時間が掛かる

チームでコーディング規約を使用することで、最初から誰が書いても同じようなスタイルでコードを書け、 上記の問題により発生する時間が削減されます。それにより、ソフトウェアの開発は加速し、開発するソフトウェアの品質の向上に繋がります。

PEP8

一般にコーディング規約は、会社、プロジェクトにより個別に規定されます。しかし、Pythonでは共通のコーディング規約がPEP8(ペップエイト)として定められています。PEP8をコーディング規約として利用することで世界中のPythonプログラマーと共通のコーディング規約を利用していることになります。以下にPEP8で規定されていることの一部を抜粋します。

  • コードのレイアウト
  • インデント
  • 1行の長さ
  • import
  • 式や文中の空白文字

より詳細な内容に関しては下記URLを参照してください。