Python에서의 주석

1. 주석 작성 방법

Python에서는 다른 많은 프로그래밍 언어들과 마찬가지로 코드에 주석을 작성할 수 있어.

주석은 그냥 다른 프로그래머들을 위한 텍스트야. Python 인터프리터는 주석에 반응하지 않고, 거기에 있는 코드를 실행하지도 않아. 주석은 프로그래머나 프로젝트 팀원들에게 코드를 이해하는 데 도움을 줘, 특히 협업하거나 장기적인 코드 유지보수에서 유용해. Python에서는 코드를 주석처리하는 여러 가지 방법이 있어.

한 줄 주석:

# 기호로 시작해. 같은 줄에서 # 뒤에 나오는 모든 것은 Python 인터프리터에서 무시돼. 이 주석 형식은 특정 코드의 간단한 메모나 설명에 사용돼. 예제:

# 이건 한 줄 주석이야
print("안녕, 세상!")  # 함수 동작에 대한 설명

여러 줄 주석:

Python에는 공식적으로 여러 줄 주석에 대한 특별한 문법은 없어, 하지만 여러 개의 한 줄 주석을 사용하거나, 따옴표 3개를 사용해서 만들 수 있어. 하지만 따옴표 3개는 실제로는 코드로 실행되지 않는 여러 줄 문자열 리터럴이야. 예:

# 이건 여러 줄 주석의 예제야
# 각 줄은 `#` 기호로 시작해

또는:

"""
이건 주석으로 사용할 수 있는 여러 줄 리터럴이야.
Python은 이걸 문자열로 해석하지만, 이 문자열이 변수에 할당되거나 표현식에 사용되지 않는 이상 아무것도 하지 않아.
"""

유용한 팁! 리터럴은 코드에 직접 기록된 작은 데이터 조각이야: 숫자, 문자열 같은 것들.

2. 주석을 작성하는 이유

코드에 주석을 사용하면 가독성이 높아지고, 유지보수와 업데이트가 쉬워지며, 팀 협업이 더 효율적이 돼. 주석은 짧고, 유익하며, 현재의 코드 상태와 일치해야 해, 그래야 코드의 문서화로서 유용하고 쓸데없는 정보를 추가하지 않아.

문서화 문자열 (docstrings):

모듈, 클래스, 메서드, 함수의 목적을 설명하기 위해 주로 그 앞에 작성되는 여러 줄 문자열이야. 이 문자열은 이중 따옴표 3쌍으로 감싸져 있으며, 자동 문서화를 위해 사용돼.

예제:

def add(a, b):
    """
    두 숫자를 더하는 함수야.
    :param a: 첫 번째 숫자
    :param b: 두 번째 숫자
    :return: a와 b의 합
    """
    return a + b

프로그래머들은 가끔 코드에 주석을 추가하면서 웃음을 주는 경우가 있어. 여기 코드에서 볼 수 있는 몇 가지 재미있는 주석의 예가 있어:

예제 1:

# 여기서 무슨 일이 일어나는지 설명하고 싶지만, 나도 이미 모르겠어.

예제 2:

# 이게 안 된다면, 그건 다른 사람의 잘못이야.

예제 3:

# 왔다, 봤다, 고쳤다... 그리고 망가뜨렸다.

예제 4:

# 내가 이걸 썼을 때, 나랑 신만 이게 어떻게 작동하는지 알았어.
# 이제는 신만 알아.

예제 5:

# 여기 낭비된 시간 = 42.

이런 주석은 개발 과정을 덜 지루하게 만들면서도, 소프트웨어 개발이 창의적이고 인간적인 작업이라는 걸 상기시켜줘.

5.3 코드를 빠르게 주석 처리

PyCharm IDE에서는 키보드 단축키를 사용해서 코드를 빠르게 주석 처리하거나 주석을 해제할 수 있어. 주석 처리하거나 해제하려는 코드 줄을 선택하고, Windows에서는 Ctrl + /(또는 macOS에서는 Cmd + /)를 누르면 돼. 이 키 조합은 선택한 각 줄에 주석 기호를 추가하거나 제거해서, 이 과정을 빠르고 효율적으로 만들어줘.