[파이썬 기초] 주석 (한 줄, 여러 줄, Docstrings, 단축키) 갓벽 가이드

목 차

1. 주석이란?
2. 한 줄 주석 (Single-line Comments)
3. 여러 줄 주석 (Multi-line Comments)
4. 문서화 문자열 (Docstrings)
5. 주석 단축키

 

주석이란?

파이썬(Python)에서 주석은 코드에 대한 설명을 추가하거나 특정 코드를 실행되지 않도록 비활성화하는 데 사용됩니다. 주석은 프로그램 실행에 영향을 미치지 않으며, 주로 코드의 가독성을 높이고 유지보수를 쉽게 하기 위해 작성됩니다.

 

---

 

한 줄 주석 (Single-line Comments)

• # 기호를 사용하여 작성합니다.
• # 뒤에 작성된 내용은 실행되지 않습니다.
• 코드의 일부를 설명하거나 주석 처리할 때 사용합니다.

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

 

---

 

여러 줄 주석 (Multi-line Comments)

큰따옴표(""")나 작은따옴표(''')로 묶인 문자열은 실행되지 않으며, 여러 줄 주석처럼 사용할 수 있습니다.
다만, 이 방식은 실제로는 문자열로 처리되므로, 보통 문서화 문자열(예: Docstring)로 사용됩니다.

"""
이 코드는 여러 줄 주석처럼 보이지만,
실제로는 문자열 리터럴입니다.
"""
print("Hello, World!")

 

---

 

문서화 문자열 (Docstrings)

💡 Docstring이란?

모듈, 함수, 클래스 등을 정의할 때 작성하는 설명을 의미합니다. 예를들어, 함수 내에 Docstring이 작성되어 있다면 __doc__ 속성을 통해 접근이 가능합니다.

• 함수, 클래스, 모듈의 첫 번째 줄에 작성된 문자열로, 해당 코드의 문서를 제공합니다.
• 보통 """ 또는 '''를 사용합니다.

def greet(name):
    """
    이 함수는 이름을 입력받아 인사말을 반환합니다.
    """
    return f"Hello, {name}!"

print(greet("Alice"))
print(greet.__doc__)  # Docstring 출력

결과:

Hello, Alice!

이 함수는 이름을 입력받아 인사말을 반환합니다.

 

---

 

주석 단축키

• VS Code: Ctrl + / (Windows) 또는 Cmd + / (Mac)
• PyCharm: Ctrl + / (Windows) 또는 Cmd + / (Mac)

 

---

 

코즐

파이썬을 배우고 싶은 사람은 누구나 파이썬 학원(국비 지원 파이썬 학원)에 가지 않고도 파이썬 공부를 하면서 실력을 쌓아나갈 수 있다고 생각합니다. 

파이썬 온라인 강의 자료를 올리면서 누구나 쉽게 파이썬을 공부하실 수 있도록 최선을 다해서 설명하도록 하겠습니다.

 

---

 

관련글

• 파이썬 아나콘다(anaconda) 설치하기
• 주피터 노트북(jupyter notebook) 웹에서 사용하는 방법 (무설치)