第15章. ドキュメンテーションの間奏曲
この作品はAIを使って翻訳されている。ご意見、ご感想をお待ちしている:translation-feedback@oreilly.com
このパートは、Pythonコードを文書化するためのテクニックやツールについて簡単に見て終わる。Pythonのコードはそれだけでも比較的読みやすいが、うまく配置された、人がアクセスしやすいコメントがあれば、他の人があなたのプログラムの動作を理解する助けになる。これから説明するように、Pythonにはドキュメンテーションを簡単にするための構文とツールの両方が用意されている。特に、ここで取り上げるPydocシステムは、コードファイルのドキュメントを、対話的なREPLではプレーンテキストとして、ブラウザではHTMLとして表示することができる。
このトピックはツールに関連する部分もあるが、Pythonの構文モデルに関わるものであり、Pythonのツールセットを理解するのに苦労している読者にリソースを提供するものでもあるので、ここで紹介する。後者の目的のために、この章は第4章で最初に与えられたドキュメンテーションのポインタも拡張している。いつものように、この章はそのパートの最後を締めくくるので、その章のクイズに加えて、よくある落とし穴についての警告と、このパートのための練習問題で終わる。
Python ドキュメントソース
この本を読んでいる時点で、Pythonには組み込み関数や例外、定義済みのオブジェクト属性やメソッド、標準ライブラリモジュールなど、驚くほど多くの機能があらかじめ用意されていることに気づき始めているだろう。そして、これらのカテゴリのそれぞれについて、まだ表面しか見ていない。
困惑している初心者がよく尋ねる最初の質問のひとつは、すべてのビルトインツールの情報をどうやって発見すればいいのか、というものだ。このセクションでは、Pythonで利用可能な様々なドキュメントソースに関するヒントを提供する。また、ドキュメント文字列(略してdocstring)と、それを利用するPythonに同梱されているPydocシステムについても紹介する。これらのトピックはコアとなる言語そのものにとってはやや周辺的なものだが、あなたのコードが大きくなったり、読者を困らせるほど複雑になったりすると、すぐに必要不可欠な知識になる。
表 15-1 にまとめたように、Python に関する情報を探す場所は様々で、一般的に冗長になっている。ドキュメントは実用的なプログラミングにおいて非常に重要なツールであるため、この後のセクションでそれぞれのカテゴリを探っていくことにする。
| フォーム | 役割 |
|---|---|
# コメント |
ファイル内ドキュメント |
dir 。 |
オブジェクトで利用可能な属性のリスト |
docstringsだ:__doc__ |
オブジェクトに添付されるファイル内ドキュメント |
Pydoc:help 関数 |
オブジェクトのインタラクティブ・ヘルプ |
| Pydoc: HTMLレポート | モジュールのドキュメントをブラウザで見る |
| スフィンクスのサードパーティツール | 大規模プロジェクトのための豊富なドキュメント |
| 標準マニュアル | 公用語と図書館の説明 |
| リソース | オンラインチュートリアル、例題など |
# コメント
これまで学んできたように、そしてで使われているように、ハッシュマークコメントはコードを文書化する最も基本的な方法だ。Pythonは(文字列リテラルの中でない限り) ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access