クラスのヘルプみたいなの欲しいんだよな

2024年6月8日

クラスのヘルプやドキュメントを生成する方法はいくつかあります。一般的な方法は、docstring（ドキュメンテーション文字列）を使用することです。以下に、クラスやメソッドにdocstringを追加して、それを表示する方法を示します。

python
class MyClass:
    """
    このクラスはサンプルのクラスです。以下に機能の説明を記述します。
    """

    def __init__(self):
        """
        このメソッドはMyClassのインスタンスを初期化します。
        """
        pass

    def my_method(self, arg):
        """
        このメソッドはサンプルのメソッドです。引数argについての説明を記述します。

        Parameters:
        arg (int): 引数の説明を記述します。

        Returns:
        str: 戻り値の説明を記述します。
        """
        return str(arg)

# MyClassのdocstringを表示する
print(MyClass.__doc__)

# my_methodのdocstringを表示する
print(MyClass.my_method.__doc__)

このように、クラスやメソッドの定義の直前にトリプルクォートでdocstringを記述し、__doc__ 属性を使用してアクセスできます。また、IDEやエディタによっては、クラスやメソッドのdocstringをホバーすることで表示される場合もあります。