[객체 지향 프로그래밍 4개의 기둥] 추상화와 문서화 스타일

파이썬에서 코드를 문서화(docstring) 하는 것은 매우 중요합니다. 특히, 협업 시 함수나 클래스의 동작을 쉽게 이해할 수 있도록 일관된 스타일의 문서화가 필요합니다. 여러 포맷이 있지만, 이번 글에서는 Google Docstring 스타일을 사용하여 함수 문서화를 작성하는 방법을 살펴보겠습니다.

 

Google Docstring 스타일이란?

• 함수나 클래스의 동작을 명확하고 간결하게 문서화하는 방식
• 가독성이 높고 협업에 유용한 포맷

📝 기본 구조

def 함수명(파라미터):
    """설명

    Parameters:
        파라미터명 (자료형): 설명
    
    Returns:
        반환값 자료형: 설명
    """

 

✨ 예제: 추천 영상 찾기 함수

def find_suggestion_videos(self, number_of_suggestions=5):
    """유저에서 추천할 영상을 찾아준다.

    Parameters:
        number_of_suggestions (int): 추천하고 싶은 영상 수. 기본값은 5
    
    Returns:
        list: 추천할 영상 주소가 담긴 리스트
    """

정리

✔ 가독성이 뛰어나고 협업에 적합
✔ 함수의 역할, 파라미터, 반환값을 명확히 설명
✔ 일관된 문서화 스타일 유지로 코드 관리 용이