파이썬 - 주석: 초보자 가이드

안녕하세요, 미래의 파이썬 마에스토들! 오늘은 프로그래밍 세계에서 매우 중요하지만 작은 것으로 보이는 주제에 대해 빠르게 몰아넣어 볼 것입니다: 주석입니다. 친절한 이웃 컴퓨터 교사로서, 여러분이 파이썬 주석의 깊이와 양면을 이해하기 위해 안내해 드릴 것입니다. 그럼, 가상의 노트패드를 준비하고 시작해 보겠습니다!

Python - Comments

파이썬 주석이란?

자세한 내용을 논하기 전에 주석이란 무엇인지 이해해 보겠습니다. 앞으로의 자신에게 레시피를 쓰는 것을 상상해 보세요. "엄마의 비밀 소스" 또는 "갤럭시 소용기로 보이게 휘리릭"과 같은 작은 메모를 추가할 겁니다. 이正是 프로그래밍에서 주석의 역할입니다 - 우리가 자신과 타인이 코드를 더 잘 이해할 수 있도록 남기는 작은 메모들입니다.

파이썬에서는, 코드를 실행할 때 파이썬 인터프리터가 완전히 무시하는 텍스트 줄입니다. 그것들은 인간의 눈뿐입니다!

파이썬 단일 줄 주석

가장 간단한 주석 형식부터 시작해 보겠습니다: 단일 줄 주석.

기본

파이썬에서 단일 줄 주석을 만들기 위해서는 해시 기호(#)를 사용합니다. # 다음에 오는 모든 것은 주석으로 간주됩니다.

# 이것은 단일 줄 주석입니다
print("Hello, World!")  # 이것도 주석이지만, 코드 뒤에 와 있습니다

이 예제에서는 첫 줄은 완전히 주석입니다. 두 번째 줄에는 코드 뒤에 주석이 있습니다. 파이썬은 print("Hello, World!") 부분만 실행합니다.

실세계 예제

보다 실용적인 예제를 살펴보겠습니다:

# 직사각형의 면적을 계산합니다
length = 10  # 길이는 미터 단위입니다
width = 5    # 너비는 미터 단위입니다
area = length * width  # 공식: 면적 = 길이 * 너비
print(f"직사각형의 면적은 {area} 제곱미터입니다")

여기서는 각 줄이 무엇을 하는지 설명하기 위해 주석을 사용하고 있습니다. 이는 특히 여러분이 배우고 있거나 코드가 더 복잡해질 때 매우 도움이 됩니다.

프로 팁

제 학생들에게는 항상 이렇게 말합니다: "주석을 쓸 때는 코드를 읽는 사람이 여러분 집을 알고 있는 고의적인 사이코패스라고 상상하세요." 약간 극적이지만, 주제를 잘 전달하는 방법입니다 - 명확한 주석은 나중에 (또는 다른 사람에게) 큰 허드아크를 피할 수 있습니다!

파이썬 다중 줄 주석

이제 여러 줄에 걸쳐 주석을 쓰고 싶다면 어떻게 해야 할까요? 파이썬은 특정한 다중 줄 주석 문법이 없지만, 우리는 손쉽게 할 수 있는 깨끗한 방법을 가지고 있습니다.

세줄 인용 사용

세줄 인용('''' 또는 """)을 사용하여 다중 줄 문자열을 만들 수 있으며, 이는 효과적으로 다중 줄 주석으로 사용될 수 있습니다:

'''
이것은 다중 줄 주석입니다.
여러 줄에 걸쳐 있습니다.
파이썬은 실행 중에는 무시합니다.
'''

"""
이것은 또 다른 방법으로
다중 줄 주석을 쓰는 방법입니다
이중 따옴표를 사용합니다.
"""

print("여기서 코드가 계속됩니다")

이 두 가지 방법은 모두 문자열을 변수에 할당하지 않기 때문에, 파이썬은 실제로는 무시합니다. 약간 꿀팁이지만, 아주 잘 작동합니다!

언제 다중 줄 주석을 사용할까요?

다중 줄 주석은 다음과 같은 경우에 매우 유용합니다:

복잡한 알고리즘을 설명할 때
함수나 클래스에 대한 개요를 제공할 때
큰 코드 조각을 일시적으로 비활성화할 때 (하지만 주의 깊게 사용하세요!)

보다 복잡한 예제를 살펴보겠습니다:

def calculate_fibonacci(n):
"""
이 함수는 피보나치 수열의 n번째 숫자를 계산합니다.

피보나치 수열은 다음과 같이 정의됩니다:
F(n) = F(n-1) + F(n-2), F(0) = 0, F(1) = 1

매개변수:
n (int): 계산할 피보나치 수열의 위치

반환:
int: n번째 피보나치 숫자
"""
if n <= 1:
return n
else:
return calculate_fibonacci(n-1) + calculate_fibonacci(n-2)

# 사용 예제
print(calculate_fibonacci(10))

이 예제에서는 함수가 무엇을 하는지, 어떻게 작동하는지 그리고 어떤 매개변수를 기대하는지 설명하기 위해 다중 줄 주석(파이썬에서는 독스트링)을 사용하고 있습니다. 이는 문서화 목적으로 매우 유용합니다.

주석을 문서화에 사용하기

주석은 단지 코드를 설명하는 데만 사용되는 것이 아니라, 문서화에도 매우 중요합니다. 좋은 문서화는 좋은 프로그래머를 훌륭한 프로그래머로 만들 수 있습니다!

독스트링

이미 위에서 독스트링의 예제를 보았습니다. 파이썬에서는 함수, 클래스 또는 모듈 정의 다음에 오는 첫 번째 문자열을 독스트링이라고 합니다. 이는 특별한 주석으로 프로그래밍적으로 액세스할 수 있습니다.

def greet(name):
"""
이 함수는 매개변수로 전달된 사람에게 인사합니다.

매개변수:
name (str): 인사할 사람의 이름

반환:
str: 인사 메시지
"""
return f"안녕하세요, {name}! 오늘 어떻게 지내세요?"

# 다음과 같이 독스트링에 접근할 수 있습니다:
print(greet.__doc__)

인라인 주석

때로는 빠른 인라인 주석이 하루를 구하기 위한 역할을 할 수 있습니다:

result = x * 5 + y / 2 - z  # 페이지 42의 특별한 공식을 사용합니다

이런 형태의 주석은 복잡한 계산이나 알고리즘을 다루고 있을 때 매우 가치가 있습니다.

주석 사용하기 위한 최상의 관행

마지막으로, 주석 사용에 대한 몇 가지 금科 법칙을 끝맺겠습니다:

규칙	설명	예제
명확하게	'왜'를 설명하는 주석을 쓰고, 단지 '무엇'만 설명하는 주석은 아닙니다	`# 무한 루프를 피하기 위해 i를 증가시킵니다`
항상 업데이트	코드를 변경할 때마다 주석을 업데이트합니다	`# 이제 개선된 알고리즘을 사용합니다 (v2.0)`
두드러지지 않게	가치가 없는 주석은 피합니다	❌ `x = x + 1 # x에 1을 더합니다`
적절한 문법 사용	주석을 다른 쓰여진 텍스트와 같이 취급합니다	`# 입력 값의 평균을 계산합니다`
복잡한 부분에 주석 달기	코드의 트icky 부분에 집중합니다	`# 입력이 비어 있을 때 경계 케이스를 처리합니다`

기억해 주세요, 주석의 목적은 코드를 더 이해하기 쉽게 만드는 것입니다. 제 학생 중 한 명이曾经说过, "좋은 주석은 좋은 재미천이라고 - 설명해야 한다면, 그 주석은 아마 그렇지 않을 것입니다!"

결론적으로, 좋은 주석을 쓰는 기술을 마스터하는 것은 모든 프로그래머에게 중요한 스킬입니다. 이는 단지 다른 사람들이 여러분의 코드를 이해할 수 있도록 도와주는 것뿐만 아니라, 여러분이几个月 또는 몇 년 후에 다시 코드를 볼 때도 매우 유용합니다. 즐거운 주석 작성하고, 여러분의 코드가 항상 명확하고 이해하기 쉬운 것이 되길 바랍니다!

Credits: Image by storyset