[파이썬초보탈출] Python - Comments

안녕하세요, 오늘은 파이썬의 주석(Comments)에 대해 알아보려 합니다. 주석은 코드의 이해를 돕고, 다른 개발자와의 협업에 큰 도움이 됩니다.

목차

1. 주석(Comments)이란?
2. 한 줄 주석(Single-Line Comments)
3. 여러 줄 주석(Multi-Line Comments)
4. 주석 사용의 좋은 예

---

1. 주석(Comments)이란?

주석은 코드가 실행되지 않는 텍스트 부분으로, 코드를 설명하거나 나중에 코드를 이해하기 쉽게 하기 위해 사용됩니다. 파이썬에서는 '#' 기호를 사용하여 주석을 작성합니다.

---

2. 한 줄 주석(Single-Line Comments)

한 줄 주석은 '#' 기호 뒤에 오는 텍스트 전체를 주석으로 처리합니다. 주로 코드의 특정 부분을 설명하거나, 임시로 코드를 비활성화할 때 사용됩니다.

# 이것은 한 줄 주석입니다.
print("Hello, World!")  # 이 코드는 화면에 'Hello, World!'를 출력합니다.

---

3. 여러 줄 주석(Multi-Line Comments)

여러 줄 주석은 여러 줄에 걸친 텍스트를 주석으로 처리하는데 사용됩니다. 파이썬에서는 여러 줄 주석을 직접 지원하지 않지만, 문자열(String)을 이용해 여러 줄 주석을 작성할 수 있습니다.

"""
이것은
여러 줄
주석입니다.
"""
print("Hello, World!")

---

반응형

4. 주석 사용의 좋은 예

주석은 코드의 이해를 돕기 위해 사용되지만, 너무 많은 주석은 코드를 복잡하게 만들 수 있습니다. 그러므로 주석은 반드시 필요한 곳에만 사용하는 것이 좋습니다.

또한, 주석은 항상 최신 상태로 유지해야 합니다. 코드가 변경되었을 때 주석도 함께 업데이트해야 합니다.

# 리스트에 정수를 추가합니다.
numbers = [1, 2, 3]  # Good

# 리스트에 정수를 추가합니다.
numbers = "123"  # Bad, 주석이 코드와 일치하지 않습니다.

---

주석은 코드의 가독성을 높이고, 코드의 목적을 명확하게 전달하는 데 매우 중요한 역할을 합니다. 알맞은 주석을 활용하여 더 나은 코드를 작성해보세요.