파이썬에서 주석은 코드의 실행에 영향을 미치지 않으면서 코드에 대한 설명이나 메모를 남길 때 사용된다. 주석을 적절히 사용하면 코드의 가독성을 높이고, 유지 보수를 쉽게 할 수 있다. 이 글에서 파이썬 주석에 대해 자세히 알아보고, 주석을 효과적으로 사용하는 방법을 학습해 보자.
Table of Contents
파이썬 주석(Comment)에 대한 이해와 활용
1. 주석의 기본 사용법
- 파이썬에서는 주석을 작성할 때 “#” 기호를 사용한다. “#” 뒤에 오는 모든 텍스트는 파이썬 인터프리터에 의해 무시된다.
- 인터프리터란? 사람이 파이썬 언어로 작성한 프로그램을 컴퓨터로 번역해주는 파이썬 쉘을 의미한다.
- 인터프리터란? 사람이 파이썬 언어로 작성한 프로그램을 컴퓨터로 번역해주는 파이썬 쉘을 의미한다.
# 이것은 한 줄 주석입니다.
print("신집사 블로그!") # 이 부분도 주석입니다.
- 위의 코드에서 print(“신집사 블로그!”) 는 실행되지만, 주석 부분은 무시된다.
2. 여러줄 주석
파이썬에서는 여러줄 주석을 위해 특별한 구문을 제공하지는 않는다. 하지만 여러줄을 작성 할 수 있는 방법이 두가지 있다.
2.1. 방법1 : 여러개의 ‘#’ 사용하기
#이것은
# 첫 번째 방법의
# 주석입니다.
2.2. 방법2 : 문자열 사용하기
- 큰 따옴표(“””) 또는 작은 따옴표(”’)를 세 번 사용하여 문자열을 작성하면 여러줄의 주석처럼 사용할 수 있다. 다만, 이 방법은 실제로는 문자열을 생성하는 것이므로, 함수나 클래스의 문서화 문자열(docstring)로 사용되는 것이 일반적이다.
"""
이것은 여러 줄 주석처럼 사용할 수 있는
문자열입니다.
하지만 실제로는 문자열 객체를 생성합니다.
"""
3. 주석의 중요성
3.1. 코드 가독성 향상
- 주석은 코드의 가독성을 높이는데 큰 역할을 한다. 특히 복잡한 로직이나 알고리즘이 포함된 코드에서는 주석을 통해 코드의 의도를 명확히 설명할 수 있다.
# 이 함수는 주어진 숫자가 소수인지 여부를 반환합니다.
def is_prime(number):
if number <= 1:
return False
for i in range(2, number):
if number % i == 0:
return False
return True
3.2. 코드 유지보수 용이
- 주석은 코드를 작성한 의도와 동작 방식을 설명하므로, 나중에 유지보수하거나 다른 개밸자가 코드를 이해하는데 도움을 줄 수 있다.
# 사용자의 나이를 입력받아 성인 여부를 출력합니다.
age = int(input("Enter your age: "))
if age >= 18:
print("아직 애기네요.")
else:
print("어른이시네요.")
4. 주석의 작성의 올바른 사용 예
- 주석을 효과적으로 사용하기 위해 다음과 같은 예시를 따르면 좋다.
4.1. 의미 있는 주석 작성
- 주석은 코드가 무엇을 하는지 보다는 왜 그렇게 하는지 설명하는 데 집중을 해야 한다.
# 잘못된 주석: 이 주석은 코드가 하는 일을 단순히 반복합니다.
i = i + 1 # i에 1을 더합니다.
# 올바른 주석: 이 주석은 코드의 의도를 설명합니다.
i = i + 1 # 다음 반복을 위해 인덱스를 증가시킵니다.
4.2. 코드와 주석의 일치
- 코드가 변경될 때 주석도 함께 업데이트 되어야 한다.
- 주석과 코드가 일치하지 않으면 오히려 혼란을 줄 수 있다.
# 이 함수는 주어진 숫자가 짝수인지 여부를 반환합니다.
def is_even(number):
return number % 2 == 0
4.3. 불필요한 주석 피하기
- 너무 당연한 내용이나, 코드 자체로 충분히 이해할 수 있는 내용은 주석으로 남기지 않는 것이 좋다.
# 잘못된 예: 너무 당연한 주석
x = 5 # x에 5를 대입합니다.
# 올바른 예: 주석 생략
x = 5
5. 결론
- 주석은 코드의 가독성과 유지보수성을 높이는 중요한 도구이다. 좋은 주석을 작성하기 위해서는 의미 있는 내용을 담고, 코드와 주석이 일치하도록 유지하며, 불필요한 주석을 피하는 것이 중요하다. 주석을 잘 활용하여 더욱 명확하고 이해하기 쉬운 코드를 작성해보자.
