Python学習ノート(十):Pythonドキュメント

Mark Lutz著の「Python学習マニュアル」をチュートリアルに、毎日1時間ほど勉強し、2週間で完成するように努力しています.---前に書いてあると
2013-7-20 20:00学習ノート
1,Pythonは#でコードコメントを開始します.Pythonでは、オブジェクトに自動的に添付できるドキュメントもサポートされており、実行時に表示できます.このような注釈は文字列として書かれており、モジュールファイル、関数、クラス文の先頭に置かれ、実行可能なコードの前に置かれています(#注釈はその前に問題ありません).Pythonはこの文字列を自動的にカプセル化します.つまり、いわゆるドキュメント文字列となり、オブジェクトの__doc__属性となります.たとえば、

"""
Module documentation
Words Go Here
"""

spam = 40

def square(x):
	"""
	function documentation
	Words Go Here
	"""
	return x**2
	
class employee:
	"class documentation"
	pass

2,Pythonには、ドキュメント文字列情報を表示するPyDocツールがあります.コマンドラインモードで、help関数でPyDocを起動します.GUIモードでは、HTMLページ形式のドキュメント情報を直接表示できます.
3,Pythonの標準マニュアルはhttp://www.python.org取得は、Python文とそのツールセットの最新の完全な説明です.Windowsでは、この標準マニュアルはPythonとともにインストールされています.
4,dir()関数は、オブジェクトのすべてのプロパティをリストするために使用され、必要なタイプの定数を入力できます.例:

dir([])
dir('')

、一部のPythonコード作成トラップ:

コロンを忘れないでください:

プログラムコードは、1行目から

を開始する.

インデントが一致する

PythonでC言語スタイルのコード

を書かないでください.

whileやrange

ではなく、できるだけ簡単なforサイクルを使用します.

必ず括弧呼び出し関数

を使用する.

インポートまたはリロード時に拡張子またはパス

を使用しないでください.