1-4. 주석, 코드 스타일, 들여쓰기 개념

안녕하세요! "Hello, World!"를 성공적으로 출력하신 것을 다시 한번 축하드립니다! 🎉 이제 파이썬 코드를 직접 작성하고 실행하는 방법을 경험해 보셨으니, 다음 단계로 넘어가서 좋은 코드를 작성하기 위한 중요한 기본 규칙들을 알아볼 시간입니다.

이번 시간에는 파이썬 코드의 가독성과 유지보수성을 높이는 데 필수적인 세 가지 개념, 바로 **주석(Comments), 코드 스타일(Code Style), 그리고 들여쓰기(Indentation)**에 대해 자세히 살펴보겠습니다.

---

Part 1: 주석 (Comments) - 코드에 설명 달기

주석은 프로그래밍 코드 안에 작성하는 설명문입니다. 파이썬 인터프리터(코드를 실행하는 프로그램)는 주석을 무시하고 실행하지 않습니다. 주석은 코드를 읽는 사람(미래의 나 자신이나 다른 개발자)이 코드가 어떤 역할을 하는지, 왜 이렇게 작성되었는지 등을 쉽게 이해하도록 돕는 역할을 합니다.

1. 한 줄 주석 (#)

가장 흔하게 사용되는 주석 방식입니다. # 기호 뒤에 작성된 모든 내용은 한 줄 주석으로 처리됩니다.

예시:

Python

 

# 이것은 한 줄 주석입니다.
print("Hello, Python!") # 이 코드도 주석이 될 수 있습니다.

# 아래 변수는 사용자 이름을 저장합니다.
user_name = "Alice"
print(user_name)

2. 여러 줄 주석 (Docstrings)

파이썬에서는 엄밀히 말해 여러 줄 주석을 위한 문법은 따로 없지만, 보통 **큰따옴표 3개("""...""")**나 **작은따옴표 3개('''...''')**를 사용하여 여러 줄에 걸쳐 설명을 작성합니다. 이는 함수나 클래스 같은 특정 코드 블록의 목적을 설명하는 "문서 문자열(Docstrings)"로 주로 사용됩니다.

예시:

Python

 

"""
이것은 여러 줄 주석입니다.
주로 코드 블록이나 파일의 시작 부분에
전체적인 설명을 작성할 때 유용하게 사용됩니다.
"""

'''
작은따옴표 세 개를 사용해도
동일하게 여러 줄 주석처럼 활용할 수 있습니다.
'''

def greet(name):
    """
    이 함수는 입력받은 이름을 사용하여 환영 메시지를 출력합니다.
    """
    print(f"안녕하세요, {name}님!")

greet("Bob")

 

 

왜 주석이 중요할까요?

• 가독성 향상: 복잡하거나 중요한 로직에 설명을 달아 코드를 이해하기 쉽게 만듭니다.
• 유지보수 용이: 시간이 지난 후에도 코드의 목적을 빠르게 파악할 수 있도록 돕습니다.
• 협업: 여러 개발자가 함께 작업할 때 서로의 코드를 이해하는 데 필수적입니다.

---

Part 2: 코드 스타일 (Code Style) - 깔끔하고 읽기 쉬운 코드

코드 스타일은 코드를 작성하는 일관된 방식과 규칙을 의미합니다. 파이썬에서는 PEP 8이라는 공식 스타일 가이드가 존재하며, 이를 따르는 것이 좋은 코드 작성 습관의 시작입니다. 일관된 스타일은 코드를 훨씬 읽기 쉽게 만듭니다.

1. PEP 8 이란?

PEP (Python Enhancement Proposal) 8은 파이썬 코드를 어떻게 작성해야 하는지에 대한 표준적인 지침을 제공합니다. 변수 이름 짓는 방법, 공백 사용, 들여쓰기 규칙 등 다양한 내용이 포함되어 있습니다. 모든 규칙을 지금 당장 외울 필요는 없지만, 대략적인 원칙을 이해하는 것이 중요합니다.

주요 PEP 8 원칙 (간단히 알아두세요!):

• 변수명, 함수명: 모두 소문자로 작성하고, 여러 단어는 밑줄(_)로 연결합니다. (예: user_name, calculate_sum)
• 클래스명: 각 단어의 첫 글자를 대문자로 작성합니다. (예: MyClass, UserManager)
• 상수명: 모두 대문자로 작성하고, 여러 단어는 밑줄(_)로 연결합니다. (예: MAX_SIZE, PI)
• 공백: 연산자(=, +, - 등) 주변에 공백을 추가하여 가독성을 높입니다.
  • 좋은 예: a = 1 + 2
  • 나쁜 예: a=1+2
• 줄 길이: 한 줄은 79자(최대 99자)를 넘지 않도록 합니다.

예시 (좋은 스타일 vs. 나쁜 스타일):

Python

 

# 나쁜 스타일 예시 (가독성 떨어짐)
Myname="철수"
a=10+20;
def calculateSum(x,y):
    return x+y
print(calculateSum(a, 5))


# 좋은 스타일 예시 (PEP 8 권장)
user_name = "영희" # 변수명 소문자, 밑줄 사용
num1 = 10
num2 = 20
total_sum = num1 + num2 # 연산자 주변 공백
# 함수명 소문자, 밑줄 사용
def calculate_sum(x, y):
    return x + y

result = calculate_sum(total_sum, 5)
print(result)

 

왜 코드 스타일이 중요할까요?

• 일관성: 코드의 일관성을 유지하여 혼란을 줄입니다.
• 가독성: 깔끔하고 예측 가능한 코드는 읽고 이해하기 쉽습니다.
• 협업: 팀 프로젝트에서 모두가 동일한 스타일로 코드를 작성하여 생산성을 높입니다.

---

Part 3: 들여쓰기 (Indentation) - 파이썬 코드 블록의 핵심!

파이썬에서 들여쓰기는 단순히 코드를 보기 좋게 만드는 것을 넘어, 코드의 의미를 결정하는 매우 중요한 문법 규칙입니다. 다른 프로그래밍 언어에서는 중괄호({}) 등으로 코드 블록을 구분하지만, 파이썬은 공백(Space) 또는 탭(Tab)으로 들여쓰기를 하여 코드 블록을 구분합니다.

1. 들여쓰기의 중요성

• 코드 블록 구분: if 문, for 문, while 문, 함수 정의(def) 등에서 특정 조건이 참일 때 실행되거나 반복될 코드, 또는 함수에 속하는 코드를 들여쓰기로 묶습니다.
• 필수 문법: 들여쓰기를 잘못하면 파이썬은 오류를 발생시킵니다.

2. 들여쓰기 규칙

• 공백 4칸 권장: 파이썬 공식 가이드(PEP 8)에서는 공백(Space) 4칸으로 들여쓰기하는 것을 권장합니다.
• 탭 vs 공백: 탭(Tab)을 사용해도 되지만, 탭의 크기는 에디터마다 다르게 보일 수 있어 혼란을 줄 수 있습니다. 따라서 공백 4칸으로 통일하는 것이 가장 좋습니다. VS Code와 같은 대부분의 에디터는 Tab 키를 누르면 자동으로 공백 4칸이 입력되도록 설정할 수 있습니다.
• 일관성: 한 파일 내에서는 반드시 공백으로만 또는 탭으로만 들여쓰기를 해야 합니다. 섞어 쓰면 오류가 발생합니다.

예시:

Python

 

# 올바른 들여쓰기 예시
if True:
    print("이것은 if문 안에 있는 코드입니다.") # if문 안에 있으므로 들여쓰기
    print("두 번째 줄도 if문 안에 있습니다.")
print("이것은 if문 밖에 있는 코드입니다.") # if문이 끝나고 들여쓰기 없음

for i in range(3):
    print(f"반복 {i}회") # for문 안에 있으므로 들여쓰기
    if i == 1:
        print("중첩된 if문입니다.") # if문 안에 있으므로 더 들여쓰기

# 잘못된 들여쓰기 예시 (오류 발생!)
# if True:
# print("이것은 오류가 발생합니다!") # 들여쓰기 해야 하는데 안 되어 있음

# def my_function():
#     print("함수 내부")
#  print("여기도 오류!") # 들여쓰기 레벨이 갑자기 바뀜 (공백 4칸 아닌 2칸 등)

 

왜 들여쓰기가 중요할까요?

• 문법 필수: 파이썬은 들여쓰기를 통해 코드의 구조를 파악하므로, 문법적으로 필수입니다.
• 코드 블록 명확성: 코드 블록의 시작과 끝을 시각적으로 명확하게 보여줍니다.
• 버그 감소: 들여쓰기 오류는 파이썬에서 흔한 오류 중 하나이므로, 올바른 들여쓰기는 버그를 줄이는 데 기여합니다.

---

마무리하며

이번 시간에는 주석, 코드 스타일, 그리고 들여쓰기라는 파이썬의 중요한 기본 개념들을 알아보았습니다. 이 세 가지는 코드를 "컴퓨터가 이해할 수 있게" 만드는 것을 넘어, "사람이 이해하고 관리하기 쉽게" 만드는 핵심 요소입니다.

처음에는 조금 낯설고 번거롭게 느껴질 수 있지만, 좋은 코드를 작성하는 습관을 들이는 것은 매우 중요합니다. VS Code와 같은 현대적인 코드 에디터들은 이러한 규칙들을 지키는 데 많은 도움을 주니 너무 걱정하지 마세요!

다음 포스팅에서는 파이썬의 가장 기본적인 구성 요소인 **변수와 자료형(숫자, 문자열, 불린)**에 대해 자세히 알아보겠습니다.

---

궁금한 점이 있다면 언제든지 질문해주세요! 다음 포스팅에서 만나요!