ドキュメントコメント

• Pythonのクラスや関数のコメントはドキュメントコメント(Googleスタイル)を採用する
• 関数の引数には型アノテーションを使用する

Googleスタイル

※これはGoogleスタイルの説明であるため、型アノテーションを使っていません。

クラスの場合

class sampleClass() :
    """クラスの説明タイトル

    クラスについての説明文

    Attributes:
        属性の名前 (属性の型): 属性の説明
    """

関数の場合

def func(arg1, arg2) :
    """関数の説明タイトル.

    関数についての説明文

    Args:
        引数の名前 (引数の型): 引数の説明

    Returns:
        戻り値の型: 戻り値の説明

    Note:
        注意事項などを記載
    """
    return True

docstring が1行で終わる場合は、同じ行を """ で閉じるようにしてください

def func():
    """関数の説明タイトル."""

型アノテーション

型アノテーションを具体的なコードで説明する。

引数と返り値に方アノテーションを使用した具体例

Googleスタイルも採用して説明する。

def add(int: a, int b) -> int:
    """足し算を行う関数.

    値を2つ受け取り、足した結果を返す.

    Args:
        a (int): 変数
        b (int): 変数
    Returns:
        int: aとbを足した結果
    """

    return a + b

返り値が複数の場合の例

以下の関数は2つの引数を返す関数です。

from typing import Tuple

def func() -> Tuple[str, int]:

    ~ 略 ~

    return a, b

引数によって戻り値が変わる場合

以下の関数は引数の文字数に応じて文字列（str型）か文字数（int型）を返す関数です．

from typing import Union

def func() -> Union[str, int]:

    ~ 略 ~

    return a

参考

Google スタイルの docstring をドキュメントに取り込む

関数の戻り値が複数ある場合の型ヒントの書き方