[파이썬] 문서화, 주석, 타입 힌트

I. 함수, 클래스 문서화

• 소프트웨어 유지보수를 위해 프로그램에 관한 설명(문서화) 필요
• 모듈의 문서화는 속성 “__doc__”에 저장하여 print로 출력 가능

가. 문서화 확인

• [예제] math 모듈의 문서화(__doc__) 확인

import math

print(math.__doc__)

[결과]
This module provides access to the mathematical functions
defined by the C standard.

나. 모듈 문서화

• 모듈 작성 시 첫 번째 문장을 문자열로 작성하여 문서화
• [예제] add 모듈 작성 시 문서화

[add.py]
"""이 모듈은 두 변수를 더하는 모듈입니다."""

def add(a, b) :
    return a + b

import add

print(add.__doc__)

[결과]
이 모듈은 두 변수를 더하는 모듈입니다.

• 작성된 모듈을 import할 때는 확장자(.py)를 제외한 모듈 이름만 입력

 

II. 주석 (Comments)

• 변수나 리턴값에 대한 자료형 등 문장 단위로 세부 설명 시 주석 사용
• 주석은 소스코드 내 샾(#) 기호를 사용하며, 문서화와 달리 실행 시 확인 불가
• [예제] 주석 달기

a = 10      # 변수 a에 10 저장
b = 20      # 변수 b에 20 저장
c = a + b   # 변수 c에 a와 b를 덧셈하여 저장
print(c)    # 변수 c의 값을 출력

[출력] (#을 사용한 주석은 실행 시 출력되지 않음)
30

 

III. 변수의 타입 힌트 (Type Hint)

• 파이썬에서는 변수에 특정 자료형을 타입으로 지정하는 방식 제공
• 타입 힌트는 소스코드 내 콜론(:) 기호를 사용하며, 변수에 관한 주석을 추가하는 기능
• [예제] 변수에 타입 힌트 지정

a : int
a = 10

print(a.__class__)

a = "문자열"

print(a.__class__)

[결과]
<class 'int'>
<class 'str'>

• 타입 힌트를 사용하더라도 파이썬의 자동 변수 타입 지정으로 인해 자동으로 Class가 변경됨

 

[참고]

잇플, “한 권으로 개발자가 원하던 파이썬 심화 A to Z”, 2019.11