[Python] Python에서 주석 사용하기

Python에서 주석 사용하기

목차

1. 주석이란?
2. 한 줄 주석
3. 여러 줄 주석
4. 코드 내 인라인 주석
5. 주석의 중요성과 사용 예시
6. 주의할 점
7. 마무리

1. 주석이란?

주석은 프로그램의 실행에 영향을 주지 않는 텍스트입니다. 주로 코드를 설명하거나, 나중에 해야 할 일을 메모하는 데 사용됩니다.

2. 한 줄 주석

한 줄 주석은 `#` 기호로 시작하며, 그 라인의 끝까지 주석으로 처리됩니다.

# 이것은 한 줄 주석입니다.

3. 여러 줄 주석

여러 줄 주석은 작은따옴표 세 개(`'''`) 또는 큰따옴표 세 개(`"""`)로 둘러싸서 표시합니다.

'''
이것은
여러 줄
주석입니다.
'''

4. 코드 내 인라인 주석

인라인 주석은 코드와 같은 줄에 존재하는 주석입니다.

x = 5  # 이것은 인라인 주석입니다.

5. 주석의 중요성과 사용 예시

- 코드 설명: 코드의 기능이나 작동 원리를 설명합니다.
- 디버깅: 특정 코드를 일시적으로 비활성화하려고 할 때 사용합니다.

# 두 수를 더하는 함수
def add(a, b):
    return a + b  # 덧셈 연산

주석 사용 사례

6. 주의할 점

- 주석은 간결하고 명확해야 합니다.
- 코드만으로 설명이 가능하다면 주석은 생략할 수 있습니다.
- 오래된 주석은 코드와 불일치할 가능성이 있으므로 주기적으로 업데이트해야 합니다.

7. 마무리

주석은 코드의 이해를 돕고, 유지 보수를 쉽게 하기 위한 중요한 도구입니다. 하지만 과도한 주석은 오히려 코드의 가독성을 해칠 수 있으므로 적절한 사용이 필요합니다.