Pythonノート:第3部文と文法第15章ドキュメントリソース

文書ディレクトリ

Pythonドキュメントリソース

注記

dir関数

ドキュメント文字列:_doc __

PyDoc:help関数

PyDoc:HTMLレポート

Pythonドキュメントリソース
形式
さぎょう
#コメント
ソースファイルドキュメント
dir関数
オブジェクトで使用可能なプロパティをリスト表示
ドキュメント文字列:_doc __
オブジェクトに添付されたソースファイルドキュメント
PyDoc:help関数
インタラクティブコマンドラインのオブジェクトヘルプ
PyDoc:HTMLレポート
ブラウザのモジュールドキュメント
Sphinxサードパーティツール
大規模なプロジェクトにより豊富なドキュメントを提供
標準マニュアルセット
公式の言語とライブラリの説明
ネットワークリソース
オンラインチュートリアル、例
既刊書
商業化加工後の参考テキスト
コメント

ドキュメント文字列は、より大規模な機能ドキュメントの最適選択

である.

#コメントは、より小さなコードのドキュメントに適用され、スクリプトまたは関数の文のグループの範囲に制限されることが望ましい

.
dir関数

に内蔵dir は、インポートモジュール、組み込みタイプ、およびデータ型の名前

を含む、オブジェクト内の任意の属性をキャプチャするオブジェクトである.
ドキュメント文字列:_doc __

#コメントのほか、Pythonはオブジェクトに自動的に添付できるドキュメントをサポートし、実行時に

を表示できます.

文法的には、この注釈は文字列として書かれ、モジュールファイル、関数、およびクラス文の上部に配置され、実行可能なコードの前に

に位置する.

ドキュメントプロトコルは、ファイルがインポートされた後も、参照のために__doc__のプロパティにコメントを保存し続けることを意味する.

このモジュールおよびオブジェクトに関連付けられたドキュメント文字列を表示するには、このファイルをインポートし、__doc__のプロパティ(すなわち、Pythonがドキュメント文字列のテキストを格納する場所)を直接印刷するだけです.

PyDoc:help関数

help()関数は、関数またはモジュールの用途の詳細な説明を表示するために使用されます.

helpを呼び出すと、必ずしも対応モジュールをインポートする必要はありませんが、helpで対応モジュールのドキュメント情報を取得する必要がある場合は、モジュールをインポートする必要があります.

help()は、内蔵モジュールのように、自分のモジュールに使用してもよい.

PyDoc:HTMLレポート

WEBブラウザでよりグラフィカルなレンダリングを行い、モジュール文書

を開く.

オープンモード:cmdに入力:python -m pydoc -b