さらなる研究では、ずっと前に、あなたがそれで何千もの複雑なを書いたりしても十何千行ものコードのことができるようになります、コードの一部を次のように記述するのに長い時間を費やし、そしてリターンを参照するには数日後、彼は読んでいない発見し、ハハ、これはあまりにも正常です。また、プロジェクトはほとんどの人が一緒に働くのいくつかさえ数十によって行われ、作業の後半で見つける、あなたが持っている、コードがコメントを追加しない場合は、あなたとまた他の人、他の人によって書かれたコードを呼び出す必要があります私は、読んで一人で他の人を聞かせて、そう書いて暴行することはできません。したがって、このような恥ずかしいことが起こる避けるために、私たちはあなたのコードの可読性を向上させる必要があります。
1行コメントと、符号分割多重線と単一行コメントをメモ#
、コメントは二重引用符のマルチライン三対であってもよいです“”” “””
ここでは、コードの意味を無視し、標準コードのコメントセクションを参照するには皆のため
def subclass_exception(name, parents, module, attached_to=None):
"""
Create exception subclass. Used by ModelBase below.
If 'attached_to' is supplied, the exception will be created in a way that
allows it to be pickled, assuming the returned exception class will be added
as an attribute to the 'attached_to' class.
"""
class_dict = {'__module__': module}
if attached_to is not None:
def __reduce__(self):
# Exceptions are special - they've got state that isn't
# in self.__dict__. We assume it is all in self.args.
return (unpickle_inner_exception, (attached_to, name), self.args)
def __setstate__(self, args):
self.args = args
class_dict['__reduce__'] = __reduce__
class_dict['__setstate__'] = __setstate__
return type(name, parents, class_dict)
コードは原則コメント:
- いないすべてのコードのコメントを追加したり、単に自分自身にコメントを追加するには、それが困難な重要な部分を理解するために見つける必要があるために
- でき中国語や英語、決してピンインオハイオ州のいずれかのコメント
- だけでなく、見るために彼らのコメントを与えることなく、他の人に、とても丁寧に書いてください