[python] 함수의 이름과 독스트링 작성 규칙

26 Dec 2023

python

파이썬에서 함수를 작성할 때, 이름과 독스트링 작성은 중요합니다. 함수의 이름은 명확하고 이해하기 쉽게 작성해야 하며, 독스트링은 함수의 설명과 사용 방법을 제공합니다.

함수의 이름 작성 규칙

함수의 이름은 소문자로 작성하고, 단어 사이에는 밑줄(_)을 사용해 구분합니다. 이를 스네이크 케이스(Snake case)라고 합니다. 예를 들어, calculate_average_score와 같이 작성할 수 있습니다.

독스트링 작성 규칙

함수의 첫 줄에는 함수의 역할을 간단하게 설명하는 한 줄 요약을 작성합니다. 이어서 빈 줄을 추가하고, 자세한 설명이 필요한 경우에는 추가 설명을 작성합니다. 독스트링은 작은따옴표(''') 혹은 큰따옴표(""") 세 개를 연속해서 작성하여 사용합니다.

def calculate_average_score(scores):
    '''주어진 점수 리스트의 평균을 계산하는 함수
    
    Args:
        scores (list): 학생들의 점수를 담은 리스트
        
    Returns:
        float: 평균 점수
    '''
    total = sum(scores)
    average = total / len(scores)
    return average

위 예시는 calculate_average_score 함수의 독스트링을 보여줍니다. 함수가 하는 일, 입력이 되는 인자의 형태, 반환 값의 형태 등을 명확하게 설명하고 있습니다.

이러한 규칙에 따라 함수의 이름과 독스트링을 작성하면 협업이나 유지보수가 쉬워지며, 코드의 가독성을 높일 수 있습니다. Python 공식 문서에서도 이러한 작성 규칙을 권장하고 있으니 참고하시기 바랍니다.

참고 자료

Python 공식 스타일 가이드 (PEP 8): https://www.python.org/dev/peps/pep-0008/
Google Python 스타일 가이드: https://github.com/google/styleguide/blob/gh-pages/pyguide.md