三連引用符（トリプルクオーテーション）は、
実は ドキュメンテーション文字列（docstring） にも使われています。
Pythonの公式スタイル（PEP 257）でもこの書き方が推奨されています。
ドキュメンテーション文字列（docstring）とは？
docstring（ドックストリング）とは：
「この関数・クラス・モジュールが何をするか」を説明する特別なコメントのことです。
普通のコメント（#）とは違い、
プログラムの中から読み取れるようになっています。
→ Python の help() や .__doc__ で見ることができます。
🧠 普通のコメントとの違い
| 種類 | 書き方 | 読み取れる？ | 使いどころ |
|---|---|---|---|
| 通常のコメント | # コメントです | ❌ 読み取れない | メモ・一時的な説明 |
| ドキュメンテーション文字列 | """説明文""" | ✅ 読み取れる | 関数やクラスの正式な説明 |
例1：関数の docstring
def greet(name):
"""指定された名前に対して挨拶を表示する関数です。"""
print(f"こんにちは、{name}さん！")
# ドキュメンテーション文字列の中身を表示
print(greet.__doc__)
実行結果：
指定された名前に対して挨拶を表示する関数です。
💡 __doc__ でドキュメンテーション文字列を取得できます。
例2：複数行の docstring（＝三連引用符の出番！）
docstring は 1 行でも書けますが、
説明が長いときは 三連引用符で複数行 にするのが基本です👇
def calculate_area(width, height):
"""
長方形の面積を計算して返します。
Parameters
----------
width : int or float
幅を指定します。
height : int or float
高さを指定します。
Returns
-------
float
長方形の面積
"""
return width * height
print(calculate_area.__doc__)
実行結果：
長方形の面積を計算して返します。
Parameters
----------
width : int or float
幅を指定します。
height : int or float
高さを指定します。
Returns
-------
float
長方形の面積
💬 ポイント：
- 三連引用符
""" """を使うことで、改行をそのまま入れられる。 - 引数や戻り値をきれいに説明できる。
例3：クラスの docstring
class Dog:
"""
犬を表すクラス。
Attributes
----------
name : str
犬の名前
age : int
犬の年齢
"""
def __init__(self, name, age):
"""犬の名前と年齢を設定します。"""
self.name = name
self.age = age
dog = Dog("ポチ", 3)
print(Dog.__doc__)
print(Dog.__init__.__doc__)
実行結果：
犬を表すクラス。
Attributes
----------
name : str
犬の名前
age : int
犬の年齢
犬の名前と年齢を設定します。
練習問題
問題1
次の関数 add(a, b) に、
「2つの数を足し合わせて返す関数です。」という docstring を追加してください。
def add(a, b):
return a + b
問題2（応用）
次の関数に、三連引用符を使った 複数行のドキュメンテーション文字列 を追加してください。
def divide(a, b):
return a / b
出力例（print(divide.__doc__)）がこうなるように：
2つの数を割り算します。
Parameters
----------
a : int or float
割られる数
b : int or float
割る数
Returns
-------
float
計算結果
解答と解説
解答1
def add(a, b):
"""2つの数を足し合わせて返す関数です。"""
return a + b
print(add.__doc__)
💡 解説：
- docstring は関数の最初の行（def のすぐ下）に書きます。
help(add)を実行してもこの説明が表示されます。
解答2
def divide(a, b):
"""
2つの数を割り算します。
Parameters
----------
a : int or float
割られる数
b : int or float
割る数
Returns
-------
float
計算結果
"""
return a / b
print(divide.__doc__)
💡 解説：
- 三連引用符で囲むことで複数行の説明が書けます。
- 改行やインデントは自由に整形可能。
- このように docstring を書くと、
help(divide)やエディタのヒントに表示されるため、チーム開発でも便利！
まとめ（初心者チェックリスト）
| ポイント | 内容 |
|---|---|
| docstring とは | 関数・クラス・モジュールの説明文 |
| 書き方 | """ 説明文 """（三連引用符） |
| 使う場所 | 関数定義やクラス定義のすぐ下 |
| 読み方 | help(関数名) または 関数名.__doc__ |
| 目的 | コードの意味を他の人（未来の自分）にわかりやすく伝える |