Pocket

Pythonで一般的なコーディングスタイルがあるそうです。

http://pep8-ja.readthedocs.org/ja/latest/

PEP8というそうです。その中でも重要そうなものを簡単に紹介したいと思います。

  1. インデントは半角スペース4つ、タブは使わない!
  2. 79文字以下で文字を折り返す
  3. プログラムのまとまりが分かるように適せん空行を入れる
  4. 文字コードはUTF-8を使う
  5. 「”」を使うか「’」を使うかは統一する。(個人的には「’」で統一した方がいいかも)
  6. 関数の説明には「docstring」という形式を用いる。(後述)
  7. 演算子の前後、コンマの後ろにはスペースを入れる。括弧の内側にはスペースを入れない。
  8. 命名規則について
    1. モジュール名:全て小文字の短い名前
    2. クラス名:CapWords 方式(単語の頭文字を大文字にしてつなげる)
    3. 関数名:小文字のみ、必要に応じて単語をアンダースコアで区切る
    4. メソッド、インスタンス名:小文字のみ、必要に応じて単語をアンダースコアで区切る
    5. 定数:全て大文字、必要に応じて単語をアンダースコアで区切ります
    6. メソッドの第一引数:常に「self」

という感じです。

 

=docstringとは=

Python的お作法に則って書かれた関数につける説明。
3重クオート「”””」を用いて記述する。以下、例。

[python]
def konoyarou(n):
    """引き数の入力された数値の分だけ「このやろう!」
    を連結した文字列を返す。
    param int : Number of repetitions 繰り返す回数
    return str : Concatenated string 連結された文字列
    """
    return ‘このやろう’ * n
[/python]

ここに詳しい説明があるので興味のある方はどうぞ。

=docstringの説明終わり=

ということで、これらを守ってPythonをコーディングしましょう!