기계는 거짓말하지 않는다

Python 함수 주석 설명 추가 본문

Python

Python 함수 주석 설명 추가

KillinTime 2024. 5. 22. 22:44

Python에서 구현한 함수가 무슨 역할을 하는지 설명을 추가하고,

VS Code와 같은 IDE에서 함수에 마우스를 올렸을 때 표시할 수 있는 방법이다.

def add_function(a, b):
    """
    return a + b function. a, b is int type

    Args:
        a (int): value1
        b (int): value2
        
    ---
    any description
    """
    return a + b

add_function(10, 20)

아래는 VS Code에서 표시되는 함수 설명이다.

Comments