[Python] __doc__の使い方 – ドキュメンテーション文字列(docstring)の取得

def add(a, b):
    """
    2つの数を加算する関数です。
    
    Parameters:
    a (int): 1つ目の数
    b (int): 2つ目の数
    
    Returns:
    int: 2つの数の合計
    """
    return a + b
# __doc__を使ってドキュメンテーション文字列を表示
print(add.__doc__)

2つの数を加算する関数です。
Parameters:
a (int): 1つ目の数
b (int): 2つ目の数
Returns:
int: 2つの数の合計

def multiply(x, y):
    """
    2つの数を掛け算する関数です。
    
    Parameters:
    x (int): 1つ目の数
    y (int): 2つ目の数
    
    Returns:
    int: 2つの数の積
    """
    return x * y
# __doc__を使ってドキュメンテーション文字列を表示
print(multiply.__doc__)

2つの数を掛け算する関数です。
Parameters:
x (int): 1つ目の数
y (int): 2つ目の数
Returns:
int: 2つの数の積

class Calculator:
    """
    簡単な計算を行うためのクラスです。
    """
    
    def add(self, a, b):
        """
        2つの数を加算するメソッドです。
        
        Parameters:
        a (int): 1つ目の数
        b (int): 2つ目の数
        
        Returns:
        int: 2つの数の合計
        """
        return a + b
# __doc__を使ってクラスのドキュメンテーション文字列を表示
print(Calculator.__doc__)

簡単な計算を行うためのクラスです。

"""
このモジュールは、基本的な計算を行うための関数を提供します。
"""
def subtract(a, b):
    """
    2つの数を減算する関数です。
    
    Parameters:
    a (int): 1つ目の数
    b (int): 2つ目の数
    
    Returns:
    int: 2つの数の差
    """
    return a - b
# __doc__を使ってモジュールのドキュメンテーション文字列を表示
print(__doc__)

このモジュールは、基本的な計算を行うための関数を提供します。

def square(number):
    """
    与えられた数の平方を計算する関数です。
    
    Parameters:
    number (int or float): 平方を計算する数
    
    Returns:
    int or float: 与えられた数の平方
    """
    return number ** 2
# __doc__を使ってドキュメンテーション文字列を表示
print(square.__doc__)

与えられた数の平方を計算する関数です。
Parameters:
number (int or float): 平方を計算する数
Returns:
int or float: 与えられた数の平方

import math
class Circle:
    """
    円を表すクラスです。
    
    Attributes:
    radius (float): 円の半径
    """
    
    def __init__(self, radius):
        """
        Circleクラスのコンストラクタです。
        
        Parameters:
        radius (float): 円の半径
        """
        self.radius = radius
    def area(self):
        """
        円の面積を計算するメソッドです。
        
        Returns:
        float: 円の面積
        """
        return math.pi * (self.radius ** 2)
# __doc__を使ってクラスのドキュメンテーション文字列を表示
print(Circle.__doc__)

円を表すクラスです。
Attributes:
radius (float): 円の半径

"""
このモジュールは、基本的な数学関数を提供します。
"""
def power(base, exponent):
    """
    指定された基数の指定された指数のべき乗を計算する関数です。
    
    Parameters:
    base (int or float): 基数
    exponent (int): 指数
    
    Returns:
    int or float: 基数のべき乗
    """
    return base ** exponent
# __doc__を使ってモジュールのドキュメンテーション文字列を表示
print(__doc__)

このモジュールは、基本的な数学関数を提供します。

def divide(a, b):
    """
    2つの数を除算する関数です。
    
    Parameters:
    a (int or float): 1つ目の数
    b (int or float): 2つ目の数
    
    Returns:
    float: 除算の結果
    """
    return a / b
# help()関数を使ってドキュメンテーションを表示
help(divide)

Help on function divide in module __main__:
divide(a, b)
    2つの数を除算する関数です。
    
    Parameters:
    a (int or float): 1つ目の数
    b (int or float): 2つ目の数
    
    Returns:
    float: 除算の結果

class Rectangle:
    """
    矩形を表すクラスです。
    
    Attributes:
    width (float): 矩形の幅
    height (float): 矩形の高さ
    """
    
    def __init__(self, width, height):
        """
        Rectangleクラスのコンストラクタです。
        
        Parameters:
        width (float): 矩形の幅
        height (float): 矩形の高さ
        """
        self.width = width
        self.height = height
    def area(self):
        """
        矩形の面積を計算するメソッドです。
        
        Returns:
        float: 矩形の面積
        """
        return self.width * self.height
# help()関数を使ってクラスのドキュメンテーションを表示
help(Rectangle)

Help on class Rectangle in module __main__:
class Rectangle(builtins.object)
 |  矩形を表すクラスです。
 |  
 |  Attributes:
 |  width (float): 矩形の幅
 |  height (float): 矩形の高さ
 |  
 |  Methods defined here:
 |  
 |  __init__(self, width, height)
 |      Rectangleクラスのコンストラクタです。
 |      
 |      Parameters:
 |      width (float): 矩形の幅
 |      height (float): 矩形の高さ
 |  
 |  area(self)
 |      矩形の面積を計算するメソッドです。
 |      
 |      Returns:
 |      float: 矩形の面積

"""
このモジュールは、基本的な数学関数を提供します。
"""
def add(a, b):
    """
    2つの数を加算する関数です。
    
    Parameters:
    a (int): 1つ目の数
    b (int): 2つ目の数
    
    Returns:
    int: 2つの数の合計
    """
    return a + b
# help()関数を使ってモジュールのドキュメンテーションを表示
help(__name__)

Help on module __main__:
NAME
    __main__ - このモジュールは、基本的な数学関数を提供します。
FUNCTIONS
    add(a, b)
        2つの数を加算する関数です。
        
        Parameters:
        a (int): 1つ目の数
        b (int): 2つ目の数
        
        Returns:
        int: 2つの数の合計