[Python] Docstring 개념 & 사용법

- NLP 공부 중 파이썬 코드블럭 데이터 전처리를 하는 와중 docstring이라는 개념이 나와서, 짚고 넘어가기

 

docstring(Document String) 개념

- 함수, 클래스, 또는 모듈에 대한 설명을 담고 있는 문자열.

- 주로 첫 번째 줄에 위치하며, 코드의 사용법과 목적을 설명.

- 해당 코드의 동작이나 목적을 문서화 함

- 주로 """ / '''로 감싸져 있으며., 함수나 클래스 정의 바로 아래에 위치함

- 이러한 docstring은 해당 객체의 doc 특수 속성으로 변환됨

 

사용 예시

작성

def add_numbers(a, b):
    """
    docstring:
    두 숫자를 더한 값을 반환합니다.

    Args:
        a (int): 첫 번째 숫자.
        b (int): 두 번째 숫자.

    Returns:
        int: 두 숫자의 합.
    """
    return a + b

 

호출(출력)

help(add_numbers)

 

이렇게 docstring을 호출하고 사용할 수 있다. 

 

NLP task에서 '파이썬 코드블럭' 데이터셋 전처리를 하기 위해, docstring을 제거해야 한다는 이유를 이제 이해완료!