Pythonチュートリアル 4章制御構造ツール(13)

コーディングスタイル

Python には、コーディングスタイルガイドとしてPEP8というものがあります。
コーディングスタイルガイドとは、コードを書く上のコーディング規約で誰が見ても読みやすく分かりやすいコードを書く為のルールの様なものです。
ここでは代表的な項目を記載します。詳細は、こちらの PEP 8 – Style Guide for Python Code を参照して下さい。

・インデントはスペース4つとし、タブは使わないこと。

・空白 4 つは (深くネストできる) 小さいインデントと (読み易い) 大きいインデントのちょうど中間に当たります。
　タブは混乱させるので、使わずにおくのが良いです。

・ソースコードの幅が 79 文字を越えないように行を折り返すこと。

・関数やクラスや関数内の大きめのコードブロックの区切りに空行を使うこと。

・可能なら、コメントは行に独立で書くこと。

・docstring を使うこと。docstring についてはこちらの記事をご参照下さい。

・演算子の前後とコンマの後には空白を入れ、括弧類のすぐ内側には空白を入れないこと。

・クラスや関数に一貫性のある名前を付けること。
　クラスにはCamelCase（単語の頭文字を大文字にして接続するスタイル）を、
　関数やメソッドにはlower_case_with_underscores（小文字の単語同士をアンダースコアで繋くスタイル）を使う。
　メソッドの第一引数としては常にselfを使う様にする。

・エンコーディングはPython のデフォルトの UTF-8 またはプレーン ASCIIを使うこと。