파이썬은 자유로운 문법과 직관적인 코드 구조로 인해 많은 개발자들에게 사랑받는 프로그래밍 언어입니다. 하지만, 파이썬 버전 간에는 몇 가지 중요한 차이점이 존재합니다. 그 중 하나는 문서화 및 주석 작성 방식의 차이입니다. 이번 글에서는 파이썬 2와 파이썬 3에서 문서화 및 주석을 작성하는 방법에 대해 알아보겠습니다.

1. 파이썬 2에서의 문서화 및 주석 작성

문서화 작성 방법

파이썬 2에서는 주로 docstring을 사용하여 함수, 클래스 및 모듈에 대한 문서화를 작성합니다. docstring은 함수/클래스 정의의 첫 번째 실행 가능한 스트링입니다. 다음은 docstring의 예입니다:

def add(a, b):
    """
    두 개의 숫자를 더하는 함수입니다.
    
    :param a: 더할 첫 번째 숫자
    :param b: 더할 두 번째 숫자
    :return: 두 숫자의 합
    """
    return a + b

위의 예시에서는 함수의 문서화를 위해 """ """ 사이에 설명을 작성하였습니다. :param은 입력 파라미터에 대한 설명을 나타내고 :return은 반환되는 값에 대한 설명을 나타냅니다.

주석 작성 방법

파이썬 2에서는 코드의 주석에는 # 기호를 사용합니다. # 이후에 작성된 내용은 해당 라인에서부터 그 줄의 끝까지 주석으로 처리됩니다. 아래는 주석 작성 예시입니다:

# 이것은 주석입니다
x = 5  # 변수 x에 5를 할당합니다

2. 파이썬 3에서의 문서화 및 주석 작성

문서화 작성 방법

파이썬 3에서도 파이썬 2와 동일한 방법으로 docstring을 사용하여 문서화를 작성할 수 있습니다. 그러나 파이썬 3에서는 Type Hints를 함께 사용할 수 있습니다. Type Hints는 함수의 파라미터 및 반환 유형을 명시하는 표기법입니다. 다음은 파이썬 3에서의 문서화 작성 예시입니다:

def add(a: int, b: int) -> int:
    """
    두 개의 숫자를 더하는 함수입니다.
    
    :param a: 더할 첫 번째 숫자
    :param b: 더할 두 번째 숫자
    :return: 두 숫자의 합
    """
    return a + b

위의 예시에서는 파라미터 a와 b가 모두 int 형식의 값이고, 함수의 반환값 또한 int 형식이라는 정보를 Type Hints를 통해 명시하고 있습니다.

주석 작성 방법

파이썬 3에서도 파이썬 2와 마찬가지로 # 기호를 사용하여 코드에 주석을 작성할 수 있습니다. 그러나 파이썬 3에서는 # 기호 뒤에 공백을 추가해야 합니다. 아래는 주석 작성 예시입니다:

# 이것은 주석입니다
x = 5  # 변수 x에 5를 할당합니다

결론

파이썬 2와 파이썬 3 모두 문서화 및 주석 작성에 있어 유사한 방식을 제공하지만, 파이썬 3에서는 Type Hints를 활용하여 변수 타입 정보를 더욱 명확하게 나타낼 수 있다는 점이 큰 차이점입니다. 프로젝트를 진행할 때, 파이썬 버전에 맞는 문서화 및 주석 작성 방식을 고려하여 개발을 진행하면 더욱 가독성이 높은 코드를 작성할 수 있을 것입니다.