5.1. 주석 사용법¶

주석은 코드의 일부로 간주되지 않으며, 코드에 대한 설명이나 메모를 추가할 때 사용합니다.

파이썬에서는 # 문자를 사용하여 주석을 작성합니다.

5.1.1. 주석의 역할¶

코드 설명

주석은 코드의 기능을 설명하거나 특정 코드 블록의 목적을 명확히 하는 데 사용됩니다.

다른 개발자나 미래의 자신이 코드를 이해하는 데 도움을 줍니다.
```
# 이 함수는 두 숫자의 합을 반환합니다.
def add(a, b):
    return a + b
```
디버깅 도움

주석을 사용하여 코드의 특정 부분을 일시적으로 비활성화할 수 있습니다.

디버깅 과정에서 유용하게 사용됩니다.
```
def calculate():
    result = add(5, 3)
    # print(result)  # 결과를 확인하기 위해 주석 처리
    return result
```

코드 수정 기록

주석을 통해 코드의 수정 내역과 이유를 기록할 수 있습니다.

코드 유지보수 시 매우 유용합니다.

# 2024-01-01: 입력 값 검증 로직 추가 (작성자: 홍길동)
def validate_input(value):
    if not isinstance(value, int):
        raise ValueError("입력 값은 정수여야 합니다.")

한 줄 주석은 # 기호를 사용하여 작성하며, 해당 줄의 끝까지 주석으로 처리됩니다.

주로 짧은 설명이나 메모를 남기는 데 사용됩니다.

# 이것은 한 줄 주석입니다.
print("Hello, World!")  # 이 부분도 주석입니다.

여러 줄 주석은 주석 블록을 만들 때 사용됩니다.

파이썬은 공식적으로 여러 줄 주석을 지원하지 않지만, 일반적으로 문자열 리터럴을 사용하여 여러 줄 주석을 만듭니다.

이때 문자열 리터럴은 실행되지 않기 때문에 주석처럼 사용할 수 있습니다.

리터럴(Literal)이란?

프로그래밍에서 소스 코드의 고정된 값 그 자체를 의미합니다.

변수에 저장되거나 함수 호출에 전달될 수 있는 값으로, 코드에서 직접 입력된 데이터입니다.

리터럴은 프로그램이 실행될 때 변경되지 않는 값이며, 다양한 데이터 타입(정수, 실수, 문자열 등)으로 표현될 수 있습니다.

"""
이 함수는 두 숫자의 합을 반환합니다.
여러 줄 주석을 사용하여 함수의 목적과
사용법을 설명할 수 있습니다.
"""
def add(a, b):
    return a + b

또는 # 기호를 각 줄마다 사용해도 됩니다.

# 이 함수는 두 숫자의 합을 반환합니다.
# 여러 줄 주석을 사용하여 함수의 목적과
# 사용법을 설명할 수 있습니다.
def add(a, b):
    return a + b