Pythonわかりやすい関数の書き方

Pythonで関数を書く時に気をつけること

今回は2つの引数(整数)をとり、その和を返す関数について考える

普通の関数の書き方

def hoge(x, y):
    result = x + y
    return result

アノテーション関数

def hoge(x:int, y:int)->int:
    '''
    引数2つの和を返す
    Args
        x: 足し算に用いる値1
        y: 足し算に用いる値2
    Return
        reslt: xとyの和
    '''
    result = x + y
    return result

こうやって書くことにより、Pythonで型を指定した関数を作成することができる。
関数の返り値の型と説明があればコードの読みやすさが段違いにあがる。