Python/사용자 정의 함수의 툴팁 작성

사용자 정의 함수의 툴팁을 만드는 방법은 Docstring을 이용하여 설명을 작성하면 된다.

Docstrings 작성하기

파이썬 함수를 정의할 때, 함수의 첫 번째 줄에 작성하는 Docstring을 사용하여 함수의 설명을 작성.
Docstring은 세 개의 큰따옴표(""") 또는 작은따옴표(''')로 둘러싸인 문자열.

Docstring의 구조

첫 줄에는 함수의 간단한 설명을 작성.

두 번째 줄은 빈 줄.

이후 줄부터는 함수의 인자와 반환값 등에 대한 설명을 작성.

설명줄 앞에 \n을 넣어 줄바꿈 처리.

def docstring_ex():
    '''
    \nline 1: 간단한 설명

    \nline 3: 상세한 설명
    \nline n: 인수 설명
    '''