[Python] 함수 정의 후 help()

[예제 코드]

def least_difference(a, b, c):
    """Return the smallest difference between any two numbers
    among a, b and c.
    
    >>> least_difference(1, 5, -5)
    4
    """
    diff1 = abs(a - b)
    diff2 = abs(b - c)
    diff3 = abs(a - c)
    return min(diff1, diff2, diff3)

[출력 화면]

> help(least_difference)

Help on function least_difference in module __main__:

least_difference(a, b, c)
    Return the smallest difference between any two numbers
    among a, b and c.
    
    
    >>> least_difference(1, 5, -5)
    4

• 함수를 정의 할 때 그 함수에 대해서 주석을 달아서 그 함수에 대해서 설명하곤 했었다. 그 방법도 나쁘지는 않지만, help() 함수로 출력 가능하게 함수에 대한 설명을 달아 놓으면 좋을 것 같다.