[python] PyCharm에서 docstring 자동 생성 설정

PyCharm에서 """을 입력하면 자동으로 docstring 템플릿이 제공되는 기능을 활용할 수 있음. 이 기능을 사용하면, docstring을 빠르고 효율적으로 작성할 수 있음. 다만, 이 템플릿은 기본적으로 Google 스타일, NumPy 스타일, reStructuredText 스타일 등을 자동으로 제공하는 것이 아니므로, 원하는 스타일로 템플릿을 설정할 수 있음.

def my_function(param1, param2):
    """
    TODO: 설명 추가
    """
    pass

PyCharm에서 docstring 자동 생성 설정

1. PyCharm 기본 docstring 템플릿 사용:

• PyCharm에서는 기본적으로 함수나 클래스 정의 후 """을 입력하면 docstring 템플릿을 자동으로 삽입해줌. 예를 들어, 함수 정의 후 """을 입력하면 기본적인 docstring 템플릿이 자동으로 채워짐. 아래 템플릿을 설정하는 방법은 아래에서 설명하겠음.

def my_function(param1, param2):
    """
    TODO: 설명 추가
    """
    pass

 

 

2. PyCharm에서 docstring 템플릿 설정: PyCharm은 다양한 스타일의 docstring을 자동으로 생성할 수 있도록 설정할 수 있음. 원하는 스타일로 docstring을 자동으로 입력하려면 설정을 조정해야 함.

 

** 설정 방법 (PyCharm에서 Docstring 템플릿 설정)

1. PyCharm 설정 열기:

• PyCharm에서 File > Settings (혹은 Mac에서는 PyCharm > Preferences)로 들어감.

2. Editor > Code Style:

• Editor > Code Style > Python을 선택함.

3. Docstring 템플릿 수정:

• 그 아래에 있는 Docstrings 탭을 클릭함.
• 여기에서 docstring 템플릿을 변경할 수 있음.

4. Docstring 스타일 선택:

• 원하는 docstring 스타일을 선택하거나, """으로 시작하는 템플릿을 수정할 수 있음.
• 예를 들어, Google 스타일로 docstring을 자동 생성하고 싶다면, 템플릿을 다음과 같이 변경할 수 있음.

예시: Google 스타일

"""
Args:
    param1 (type): 설명
    param2 (type): 설명

Returns:
    type: 설명
"""​

 

5. 저장 후 사용:

• 설정을 저장한 후, 새로운 함수나 클래스에서 """을 입력하면 설정한 스타일의 docstring 템플릿이 자동으로 입력됨.

 

PyCharm에서 Google 스타일, NumPy 스타일 템플릿을 사용하는 방법

PyCharm에서는 기본적으로 Google, NumPy, reST 스타일의 docstring을 지원하는 템플릿을 제공하지 않음. 하지만, 자동 완성 기능을 사용하여 스타일을 맞출 수 있음. 예를 들어, Google 스타일의 docstring을 작성하고 싶다면, 위의 설정에서 docstring 템플릿을 수정하여 이를 Google 스타일로 설정하는 것이 가능함.

Google 스타일 템플릿 예시

"""
Args:
    param1 (type): 설명
    param2 (type): 설명

Returns:
    type: 설명
"""

 

기타 팁

• PyCharm에서 자동화된 docstring 템플릿을 사용하는 것 외에도, docstring을 작성할 때 Ctrl + Q (Windows/Linux) 또는 Cmd + Q (Mac)를 눌러 문서화 정보를 확인할 수 있음. 이 기능은 함수나 클래스의 docstring을 확인할 때 유용함.

결론

• PyCharm에서 """을 입력하면 docstring 템플릿이 자동으로 생성되며, 이를 통해 코드 문서화를 빠르게 작성할 수 있음.
• 원하는 docstring 스타일(Google, NumPy, reST 등)을 설정하여 일관된 문서화 스타일을 유지할 수 있음.