[Python] Docstring

docstring은 python에서 클래스, 함수, 메소드 등을 설명하기 위해 사용하는 문자열이다.
보통 프로젝트를 진행할 때 사용하며, python에서 주로 사용한다.

특징

def docstring():
	"""docstring 제목
    여러 내용을 작성할 수 있다.
    줄을 바꿀 수 있다.
    """
    print("함수 내용")
    
    # 주석은 한 줄로만 표현한다.

주석하는 부분과 다르게 함수를 표현할 수 있게 여러줄로 표현할 수 있다.
또한, 내용을 vscode에서 함수 설명으로 볼 수 있다.

코드 리뷰나 나중에 코드를 볼 때 아주 좋은 듯하다.

작성방법

class docs():
	"""클래스 제목
    
    클래스에 대한 설명문
    
    Attributes:
    	속성의 이름 (속성의 데이터형): 속성의 설명
    """

 
def docstring(a, b):
	"""함수 설명
    
    Args:
    	a(타입): 설명
        b(타입): 설명
    
    Raises:
    	에러 이름 : 설명
    
    Returns:
    	타입: 설명
    """
    c = a+b
    return c

작성법은 위와 같다.

---

전체 예시

..생략..
class User(AbstractBaseUser):
    """유저 모델

    Attributes:
        email : 로그인 이메일
        username : 닉네임
        is_active : 활성화 여부
        is_admin : 관리자 계정 여부
        image : 프로필사진 필드
        achieve : 보유 칭호 필드
        wear_achievement : 착용중인 칭호 정보
    """
..생략..

..생략..
class UserDetailView(APIView):
    """회원정보

    회원 정보 보기, 수정, 삭제를 처리하는 뷰
    """

    def get(self, request, user_id):
        """회원정보 조회

        Args:
            user_id : 회원 고유 아이디

        Returns:
            정상 200 : 회원정보 반환
            오류 404 : 회원정보 없음
        """
..생략..