勉強の為に引用しました。
http://docs.python.jp/3.5/tutorial/controlflow.html#break-and-continue-statements-and-else-clauses-on-loops
4.8. 間奏曲: コーディングスタイル¶(原文)
これからより長くより複雑な Python のコードを書いていくので、そろそろ コーディングスタイルについて語っても良い頃です。ほとんどの言語は様々なスタイルで書け (もっと簡潔に言えば フォーマットでき)、スタイルによって読み易さが異なります。他人にとって読み易いコードにしようとするのはどんなときでも良い考えであり、良いコーディングスタイルを採用することが非常に強力な助けになります。
Python には、ほとんどのプロジェクトが守っているスタイルガイドとして PEP 8 があります。それは非常に読み易く目に優しいコーディングスタイルを推奨しています。全ての Python 開発者はある時点でそれを読むべきです。ここに最も重要な点を抜き出しておきます:
- インデントには空白 4 つを使い、タブは使わないこと。空白 4 つは (深くネストできる) 小さいインデントと (読み易い) 大きいインデントのちょうど中間に当たります。タブは混乱させるので、使わずにおくのが良いです。
- ソースコードの幅が 79 文字を越えないように行を折り返すこと。こうすることで小さいディスプレイを使っているユーザも読み易くなり、大きなディスプレイではソースコードファイルを並べることもできるようになります。
- 関数やクラスや関数内の大きめのコードブロックの区切りに空行を使うこと。
- 可能なら、コメントは行に独立で書くこと。
- docstring を使うこと。
- 演算子の前後とコンマの後には空白を入れ、括弧類のすぐ内側には空白を入れないこと:
a = f(1, 2) + g(3, 4)
。 - クラスや関数に一貫性のある名前を付けること。慣習では
CamelCase
をクラス名に使い、lower_case_with_underscores
を関数名やメソッド名に使います。常にself
をメソッドの第 1 引数の名前 (クラスやメソッドについては クラス初見 を見よ) として使うこと。 - あなたのコードを世界中で使ってもらうつもりなら、風変りなエンコーディングは使わないこと。どんな場合でも、Python のデフォルト UTF-8 またはプレーン ASCII が最も上手くいきます。
- 同様に、ほんの少しでも他の言語を話す人がコードを読んだりメンテナンスする可能性があるのであれば、非 ASCII 文字も識別子に使うべきではありません。
脚注
[1] |
実際には、オブジェクトへの参照渡し (call by object reference) と書けばよいのかもしれません。というのは、変更可能なオブジェクトが渡されると、関数の呼び出し側は、呼び出された側の関数がオブジェクトに (リストに値が挿入されるといった) 何らかの変更に出くわすことになるからです。
|
0 コメント:
コメントを投稿