1
これは、私がシリアル接続を介してデータを読み込んでいるプロジェクトに使用しているシンプルなフィルタです。最初にdocstringを書き込もうとすると良いでしょう。誰にも何か提案はありますか？私はPEP 257を読んでいます。それはクラスなので、キーワード引数は__init__の後に来るべきですか？この単純なpythonクラスとそのdocstringをどうすれば改善できますか？
もしも（ドキュメントストリングだけでなく）それを書く良い方法があれば、人々が私を正しい方向に向けることができれば嬉しいです。
class Filter(object) :
"""Return x if x is greater than min and less than max - else return None.
Keyword arguments:
min -- the minimum (default 0)
max -- the maximum (default 0)
Notes:
Accepts integers and integer strings
"""
def __init__(self, min=0, max=0) :
self.min = min
self.max = max
def __call__(self, input) :
try :
if int(input) <= self.max and int(input) >= self.min :
return int(input)
except : pass
http://codereview.stackexchange.com/?as=1おそらくこの質問のためのより良い場所ですが、私は[Googleのpythonスタイルのガイド]（http：// google-styleguide。 googlecode.com/svn/trunk/pyguide.html?showone=Comments#Comments）。docstringはかなりうまく適合しているようです。このような単純なケースでは、ドキュメントを評価するのは難しいです。複雑な関数やクラスを簡単に使用すると、ドキュメントに最も感謝しています。 –
私は完全に理解しています。私は単純な例では、コードが実際に何をしているのか分からないため、実際に何をしてしまったのか、コメントすることができないのではなく、素早く読むことが簡単になると考えました。 – beoliver
あなたのインタフェースとあなたのドキュメントの批評を得ることを考慮しましたか？ –