4장: 주석 및 문서화
주석은 코드에 설명을 추가하여 가독성을 높이고, 다른 사람들이 코드의 의도를 이해하기 쉽게 도와줍니다. 이 장에서는 파이썬에서 주석을 작성하는 방법과 주석을 활용한 문서화 방법에 대해 알아보겠습니다.
#### 4.1 단일 행 주석
파이썬에서는 `#` 기호를 사용하여 단일 행 주석을 작성할 수 있습니다. 주석은 코드의 오른쪽에 작성하거나 독립된 줄에 작성할 수 있습니다.
```python
# 이 코드는 변수 a에 10을 할당합니다.
a = 10 # a는 정수형 변수입니다.
```
#### 4.2 인라인 주석
인라인 주석은 코드의 오른쪽에 작성되는 주석입니다. 코드와 주석 사이에 최소한 하나의 공백을 두는 것이 좋습니다.
```python
a = 10 # 변수 a에 10을 할당합니다.
b = 20 # 변수 b에 20을 할당합니다.
```
#### 4.3 다중 행 주석
파이썬에는 다중 행 주석을 위한 특별한 문법은 없지만, 여러 줄에 걸쳐 `#` 기호를 사용하여 다중 행 주석을 작성할 수 있습니다.
```python
# 이 코드는 두 변수의 합을 계산합니다.
# 변수 a와 b에 값을 할당하고,
# 그 합을 변수 c에 저장합니다.
a = 10
b = 20
c = a + b
```
#### 4.4 도크스트링 (Docstring)
도크스트링은 함수, 클래스, 모듈의 설명을 작성하는 데 사용됩니다. 도크스트링은 큰따옴표 세 개(`"""`)로 감싸서 작성하며, 해당 객체의 첫 번째 줄에 위치해야 합니다.
```python
def add(a, b):
"""
두 수의 합을 반환하는 함수입니다.
매개변수:
a (int): 첫 번째 정수
b (int): 두 번째 정수
반환값:
int: 두 수의 합
"""
return a + b
print(add(10, 20))
```
#### 4.5 프로그래밍적으로 도크스트링 접근
도크스트링은 `__doc__` 속성을 통해 프로그래밍적으로 접근할 수 있습니다. 이를 통해 함수, 클래스, 모듈의 설명을 동적으로 확인할 수 있습니다.
```python
def multiply(a, b):
"""
두 수의 곱을 반환하는 함수입니다.
"""
return a * b
print(multiply.__doc__) # 출력: 두 수의 곱을 반환하는 함수입니다.
```
#### 4.6 도크스트링을 사용한 문서 작성
도크스트링은 코드의 문서화를 자동으로 생성하는 도구와 함께 사용할 수 있습니다. 예를 들어, `Sphinx`와 같은 도구를 사용하면 도크스트링을 기반으로 HTML 문서나 PDF 문서를 생성할 수 있습니다.
```python
class Calculator:
"""
간단한 계산기 클래스입니다.
메서드:
add(a, b): 두 수의 합을 반환합니다.
subtract(a, b): 두 수의 차를 반환합니다.
multiply(a, b): 두 수의 곱을 반환합니다.
divide(a, b): 두 수의 나눗셈 결과를 반환합니다.
"""
def add(self, a, b):
"""
두 수의 합을 반환합니다.
"""
return a + b
def subtract(self, a, b):
"""
두 수의 차를 반환합니다.
"""
return a - b
def multiply(self, a, b):
"""
두 수의 곱을 반환합니다.
"""
return a * b
def divide(self, a, b):
"""
두 수의 나눗셈 결과를 반환합니다.
"""
return a / b
calc = Calculator()
print(calc.add(10, 5)) # 출력: 15
print(calc.subtract(10, 5)) # 출력: 5
print(calc.multiply(10, 5)) # 출력: 50
print(calc.divide(10, 5)) # 출력: 2.0
```
이상으로, 파이썬의 주석 및 문서화 방법에 대해 알아보았습니다. 다음 장에서는 날짜와 시간 관련 작업에 대해 더 자세히 알아보겠습니다. 질문이나 요청사항이 있으시면 댓글로 남겨주세요!
---
이 글의 내용은 GoalKicker.com의 Python Notes for Professionals 책을 참조하였습니다.
댓글
댓글 쓰기