コーディング規約

pep8(Python Enhancement Proposal)」から具体例を引用する。
  具体例を参考にし、開発環境に即して修正願います。

1.インデントのスペース数を揃える

 「スペースは4つ」で揃えるとあるが「2つ」で問題なし。

if num % 2 == 0:
  msg = "偶数"

2.1行の長さは79文字まで

 「79文字以内」に制限するとあるが、読みやすさの観点からも制限を設ける方がよい。行の途中での改行は「\(半角バックスラツシュ)」を使用する。

print(100 + 200 + 300 +\
      400 + 500)

3.文字列の引用符を揃える

 Python では、シングルコーテーション「’」で囲まれた文字列と、ダブルコーテーション「”」で囲まれた文字列は同じで扱い。どちらかに揃える。
 文字列の中に引用符を含む場合は、逆の引用符を使う。

str = "括弧の中についてはコーテーション'で囲む"

4.式や文中の空白文字

 開始括弧 ( の直後や終了括弧 ) の直前には空白文字を入れない。
 カンマ 、 やセミコロン : の直前には空白文字を入れない
 カンマ 、 やセミコロン : の直後には空白文字を入れる

print("空白文字を入れない")
print("直前には入れない", "直後には入れる")

5.演算子の前後に空白文字を入れる

 見易さの観点で空白文字を演算子の前後に入れる。

weight = height * height * 22

6.無駄なスペースは入れない

 最初は項目が揃って見易いが、その後の変更で項目の長さが変わったりすると、結果的に最初に入れたスペースは見にくくなる。

#
# 悪い例
height = 1.8
bmi    = 22
weight = height * height * 22
#
# 良い例
height = 1.8
bmi = 22
weight = height * height * 22

7.スライスのコロンの前後に空白文字は入れない

 見易さを優先させる。

list1[0:2]
list2[::2]
list3[4::-1]

8.import文は行を分ける

 取込む内容を明確にする。

#
# 悪い例
import item1, item2
#
# 良い例
import item1
import item2

9.命名規則

 関数や変数
  全て小文字を使用する。単語と単語はアンダースコア(_)で区切る。
 定数
  全て大文字を使用する。単語と単語はアンダースコア(_)で区切る。
 クラス
  先頭一文字を大文字にする。
 その他
  適宜「pep8」を参照して決める。
  


投稿日

カテゴリー:

,

投稿者:

コメント

コメントを残す

メールアドレスが公開されることはありません。 が付いている欄は必須項目です