[파이썬][초급] Chapter03. 주석과 코드 스타일

파이썬을 포함한 대부분의 프로그래밍 언어에서는 주석을 통해 코드에 대한 설명을 추가할 수 있습니다. 주석은 프로그램 실행에는 영향을 주지 않지만, 코드를 읽는 사람에게 중요한 정보를 전달하는 수단이 됩니다. 또한 일관된 코드 스타일을 유지하는 것은 협업과 유지보수에 매우 중요합니다.

● 주석의 종류

파이썬에서는 샵 기호(#)를 사용하여 한 줄 주석을 작성합니다. 주석은 코드의 우측이나 단독으로 한 줄에 작성할 수 있습니다. 예:

# 이 코드는 변수 x에 10을 저장합니다.
x = 10  # 초기값 설정

여러 줄을 주석 처리하고 싶을 때는 따옴표 세 개(''' 또는 """)를 사용하는 방식이 있으나, 이 방식은 주석이 아니라 문자열로 처리되므로 실제 주석으로는 권장되지 않습니다.

● 좋은 주석의 예

주석은 코드의 의도를 설명하는 데 집중해야 하며, 너무 자명한 내용은 오히려 불필요할 수 있습니다. 예를 들어 i = i + 1 # i에 1을 더함과 같은 주석은 불필요하지만, 반복문 내에서의 증가 이유를 설명하는 주석은 도움이 됩니다.

또한 주석은 항상 최신 상태를 유지해야 하며, 코드와 불일치하는 오래된 주석은 오히려 혼란을 초래할 수 있습니다.

● 파이썬 코드 스타일 (PEP 8)

파이썬에는 권장되는 코드 스타일 가이드인 PEP 8이 존재합니다. 주요 규칙은 다음과 같습니다:

• 들여쓰기는 공백 4칸을 사용합니다.
• 한 줄의 길이는 79자 이내로 제한합니다.
• 함수명, 변수명은 소문자와 밑줄로 작성합니다. 예: get_user_name
• 클래스명은 단어마다 대문자를 사용하는 카멜케이스를 사용합니다. 예: UserProfile

● 마무리

이번 장에서는 파이썬에서 주석을 작성하는 방법과 좋은 주석의 예, 그리고 일관된 코드 스타일을 위한 PEP 8 규칙에 대해 알아보았습니다. 깔끔한 코드는 협업과 유지보수를 쉽게 하며, 학습 과정에서도 큰 도움이 됩니다. 다음 장에서는 숫자형 자료형과 관련된 다양한 연산을 살펴보겠습니다.