コーディングスタイルの重要なポイント
- インデントはスペース4つとし、タブ(TAB)は使わない
- 79文字以下で行を折り返す
- 可能であればコメント行は独立させる。同じ行に書かない
- docstringをつかう
- 演算子の周囲やカンマの後ろにはスペースを入れるが、かっこ()のすぐ内側にはスペースを入れない
- クラスや関数には一貫した命名をおこなう。
- クラス:UpperCamelCase – 単語の頭文字を大文字 例:MenuItem
- 関数&メソッド:lower_case_with_underscores 例:get_total()
- 国際的な環境で使うつもりのコードでは手前勝手なエンコーディングをつかわない。(UTF-8 or プレーン ASCII)
- 非ASCIIキャラクタは使わない
- Pythonでは固守すべきものとしてPEP8が出てきている
“docstring”のルール
- ドキュメンテーション文字列(docstring)
- docstringの1行目では、常にオブジェクトの目的を短く簡潔に要約して記載すること
- docstringの行は、大文字で始まり、ピリオドで終わること。さらに続きがある場合は、ドキュメンション文字列の2行目を空行としようやくと他の記述を視覚的に分離する
例:
In [1]: def fibo(n):
...: """ This is fibonacci.
...:
...: repeats calculation till 'n'
...: """
...: a, b = 0, 1
...: while a < n:
...: print(a, end=' ')
...: a, b = b, a + b
...:
In [2]: print(fibo.__doc__)
This is fibonacci.
repeats calculation till 'n'