プログラミング学習の記録 781 14章(Pythonのドキュメント)の練習問題1(ドキュメンテーション文字列の使用)『初めてのPython 第3版』(Mark Lutz 著、夏目 大 訳、オライリー・ジャパン、2009年、ISBN978-4-87311-393-7)

開発環境

• OS X Lion - Apple(OS)
• TextWrangler(Text Editor) (いずれはBBEditを入手したい！)
• Script言語: Python

『初めてのPython 第3版』(Mark Lutz 著、夏目 大 訳、オライリー・ジャパン、2009年、ISBN978-4-87311-393-7)の 14章(Pythonのドキュメント)の練習問題1を解いてみる。

1.

長くて詳しい説明や、ソースを開かなくても知ることが出来るようにしたいもの、対応するオブジェクトの「__doc__」属性値としたいもの(具体的にはモジュールファイルの説明や関数、クラスなどの説明)はコメントではなくドキュメンテーション文字列を使用するべき。

とりあえずドキュメンテーション文字列を使用するべきではない場合かもしれないけどコメントとドキュメンテーション文字列を Pythonのプログラムのコードの中に記述してみる。

コード(TextWrangler)

#!/usr/bin/env python #encoding: utf-8 "モジュール" # コメント1 print "Hello, World!" """ 複数行に渡る ドキュメンテーション文字列 """ #　コメント2

入出力結果(Terminal)

$ ./python_program.py Hello, World! $