Python Function Docstrings

이 튜토리얼에서는 docstring을 사용하여 함수에 문서를 추가하는 방법에 대해 배웁니다.

 

1. help() 함수 소개

Python은 함수 문서를 표시할 수 있는 help()라는 내장 함수를 제공합니다.

 

다음 예제는 print() 함수의 문서를 보여줍니다.

help(print)

 

Output:

print(...)
    print(value, ..., sep=' ', end='\n', file=sys.stdout, flush=False)

    Prints the values to a stream, or to sys.stdout by default.
    Optional keyword arguments:
    file:  a file-like object (stream); defaults to the current sys.stdout.
    sep:   string inserted between values, default a space.
    end:   string appended after the last value, default a newline.
    flush: whether to forcibly flush the stream.

 

help() 함수를 사용하여 모듈, 클래스, 함수 및 키워드의 문서를 표시할 수 있습니다. 이 자습서는 함수 문서에만 중점을 둡니다.

 

2. Docstrings을 사용하여 함수를 문서화하기

함수를 문서화하기 위해 docstring 을 사용할 수 있습니다. PEP 257은 docstring 규칙을 제공합니다.

함수 본문의 첫 줄이 문자열이면 파이썬은 그것을 독스트링으로 해석합니다. 예를 들어:

def add(a, b):
    "Return the sum of two arguments"
    return a + b

 

그리고 help() 함수를 사용하여 add() 함수의 문서를 찾을 수 있습니다.

help(add)

 

Output:

add(a, b)
    Return the sum of two arguments

 

일반적으로 여러 줄 독스트링을 사용합니다.

def add(a, b):
    """ Add two arguments
    Arguments:
        a: an integer
        b: an integer
    Returns:
        The sum of the two arguments
    """
    return a + b

 

Output:

add(a, b)
    Add the two arguments
    Arguments:
            a: an integer
            b: an integer
        Returns:
            The sum of the two arguments

 

파이썬은 함수의 __doc__ 속성에 독스트링을 저장합니다.

다음 예제에서는 add() 함수의 __doc__ 속성에 액세스하는 방법을 보여줍니다.

 

add.__doc__

 

3. Summary

• 함수의 문서를 얻으려면 help() 함수를 사용하십시오.
• 한 줄 또는 여러 줄 문자열을 함수의 첫 번째 줄로 배치하여 문서를 추가합니다.
       

 

 

refreance: https://www.pythontutorial.net/python-basics/python-function-docstrings/