함수 설명 표시

좋은 함수 작성 습관은 자신이 만든 함수에 대하여 목적 및 반환값과 매개변수 사용법에 관한 내용을 함께 담아두는 것입니다. 이렇게 하는 것은 추후에 작성한 함수를 재사용 하는 경우 가독성과 활용성을 높여주기 때문입니다.

def variant_adder(*var_ins):
    ''' variant_adder 함수는 가변 인자 입력에 대한 덧셈을 지원합니다.
    더해지는 덧셈은 사용자가 입력하는 인자 개수에 따라서 달라집니다.

    var_ins : 입력값, 사용 조건에 따라서 변경됨
    반환값 : 모든 입력값 들의 합 
    '''
    var_tot = 0
    for cnt in var_ins:
        var_tot += cnt        
    
    return var_tot

var_ret = variant_adder(1,2,3,4,5,6,7,8,9)
print(var_ret)

help(variant_adder)

print(variant_adder.__doc__)

위의 내용은 가변인자 함수 예제에 함수 설명을 첨부한 것입니다. 2행부터 7행을 보면 ''' ''' 사이에 함수 설명에 관한 여러 줄의 설명이 있습니다. 해당 내용의 경우 Python의 기본에 있는 문자열(String) 출력 부분에 있던 여러줄의 문자열 사용에 대한 내용으로 다뤘던 것입니다. 여기서는 해당 내용을 마치 여러줄의 주석(Comment)을 사용하는 것과 같은 효과를 나타냅니다. 그러나, Python에서는 ''' ''' 안의 내용이 단순히 주석으로만 처리되지는 않습니다.

17행의 help라는 내장함수를 사용해서 variant_adder에 관한 설명을 확인하면 2행과 7행 사이의 주석이 표시됩니다. 단 이 내용은 Python shell에서 동작하는 것이라 출력화면으로 직접적인 표시는 되지 않습니다.(VS code 등으로 수행하면 터미널에서만 출력됩니다.) 한편 19행의 variant_adder.__doc__ 를 출력하면 역시 2행과 7행의 주석이 나타납니다. 이것은 함수 설명 표시를 넣는 행위가 자동적으로 __doc__ 객체에 할당된 것을 의미합니다.

예제

1. 섭씨 온도를 입력받아서 화씨 온도로 변환하는 함수를 작성하십시오.

2. 화씨 온도를 입력받아서 화씨 온도로 변환하는 함수를 작성하십시오.

3. 1과 2에 대하여 각각 함수 사용에 관한 설명을 추가하십시오.

4. 작성한 함수를 사용하는 예제를 작성해 보십시오.

섭씨 온도 변환 공식

에서	으로	변환 공식
섭씨	화씨	°F = °C × 1.8 + 32
화씨	섭씨	°C = (°F − 32) / 1.8