Python学習ノート12

chapter_12
ドキュメント
コメント

Python用'#'号にコメントを追加する.

Pythonのコメントは__に保存されますdoc__属性の

#docstrings.py

""" Module documentation Words Go Here """

spam = 40

def square(x):
    """ function documentation can we have your liver then? """

    return x**2     #square

class Employee:
    "class documentation"
    pass

print(square(4))
print(square.__doc__)

>>> import docstrings
16

    function documentation
    can we have your liver then?

>>> print(docstrings.__doc__) #      

Module documentation
Words Go Here

>>> print(docstrings.square.__doc__) #      

    function documentation
    can we have your liver then?

>>> print(docstrings.Employee.__doc__) #     
class documentation

一般的なコード作成のトラップ

コロンを忘れないでください:複合文の最初の行の最後に入力':'

を覚えておいてください.

最初の列から、トップレベルのプログラムコードが最初の列から

であることを確認する.

インデントが一致する

PythonにCコード

を書かないでください.

は、whileまたはrange

ではなく、簡単なforサイクルを使用する.

賦値文の可変オブジェクトに注意し、共有参照

を防止する.

元の場所でオブジェクトを変更した関数がlistなどの結果を返すことを期待しないでください.append,list.sort

必ず括弧呼び出し関数

を使用する.

拡張子とパス

はインポートとリロードで使用しないでください.