파이썬 함수 document 작성법 `__doc__`

파이썬 함수 document 작성법 __doc__¶

• 파이썬 함수를 만들면, 작성한 함수에 대한 설명을 위해 document를 작성합니다.
• document 작성은 함수 이름 바로 밑에 """ """ 를 이용하는 방법과 __doc__ 메소드를 이용하는 방법이 있습니다.

""" """ doc을 사용하는 방법

In [1]:

def my_function(parameter):
    """ Function to say hello to someone with quote"""
    print(f"Hello {parameter}")

In [2]:

# help 함수를 이용하여 document 내용을 확인할 수 있습니다.
help(my_function)

Help on function my_function in module __main__:

my_function(parameter)
    Function to say hello to someone with quote

In [3]:

# 혹은 __doc__ 메소드를 호출할 수 도 있다.
my_function.__doc__

Out[3]:

' Function to say hello to someone with quote'

__doc__ 메소드를 이용하는 방법

In [4]:

def my_function(parameter):
    print(f"Hello {parameter}")

my_function.__doc__ = " Function to say hello to someone with __doc__"

In [5]:

help(my_function)

Help on function my_function in module __main__:

my_function(parameter)
    Function to say hello to someone with __doc__

In [6]:

# 단 str 과 같은 내장함수는 __doc__함수에 새로운 내용을 넣지 못하게 제한을 걸어 두었다.
str.__doc__ = "test"

---------------------------------------------------------------------------
TypeError                                 Traceback (most recent call last)
<ipython-input-6-5681ea7d1a59> in <module>
      1 # 단 str 과 같은 내장함수는 __doc__함수에 새로운 내용을 넣지 못하게 제한을 걸어 두었다.
----> 2 str.__doc__ = "test"

TypeError: can't set attributes of built-in/extension type 'str'