2023-06-23 TIL

[Python] Docstring (독스트링)

독스트링은 Python에서 클래스, 함수, 메소드 등을 설명하기 위해 사용하는 문자열이다.
다른 언어에서도 사용할 수 있지만, 보통은 Python에서 많이 쓰이고 있다.

❓ 주석과의 차이?

1. 줄바꿈

독스트링과 주석의 가장 큰 차이라고 하면 줄바꿈을 꼽을 수 있다.

2. (vscode에서) 함수 설명

독스트링을 적용하고 싶은 클래스 / 함수 / 메소드에 써주면
vscode에서는 커서를 댔을 때 독스트링 설명이 그대로 따라붙는다!

이게 진짜 장점.

💡 독스트링 사용법

class docs():
	"""클래스 설명 제목

     클래스에 대한 설명문

    Attributes:
        속성의 이름 (속성의 데이터형): 속성의 설명
       	속성의 이름 (:obj:`속성의 데이터형`): 속성의 설명.
  """
  my_str = "hi"
  my_int = 1

def calculator(a, b):
    """<요약해서 설명하기>

    Args:
        a (int): <설명>
        b (int): <설명>

    Raises:
        에러 이름: 설명

    Returns:
        타입: 설명
    """
    sum = a + b
    return c

이런 식으로 작성을 해주면 된다!