[Python]파이썬 코드의 가독성을 높이는 데 주석 활용하기

python 프로그래밍에서 주석은 코드를 작성할 때 매우 중요한 역할을 합니다. 이번 글에서는 주석의 개념과 목적부터 시작하여 주석의 종류와 처리 방법, 그리고 주의해야 할 사항까지 자세히 살펴보겠습니다.

≣ 목차

• 주석이란❓
• 주석의 목적❗
• 주석 종류 및 처리 방법👩‍💻
• 주의사항⚠️
• 핵심내용👀

---

1. 주석이란❓

프로그램 코드 내에 삽입된 사용자의 메모를 의미합니다. 주석은 컴파일러와 인터프리터에 무시되어 실행되지 않으며 코드에 대한 가독성과 이해력을 향상하는 필수적인 요소입니다.

---

2. 주석의 목적❗

▪ 소스코드에 대한 설명글을 작성할 때 필요합니다.

▪ 지금 당장 사용하지 않는 코드를 있을 때 필요합니다. (디버깅)

---

3. 주석 종류 및 처리 방법👩‍💻

▶한 줄 주석: 제일 앞에 #사용

# 주석 exam 
print('한 줄 주석입니다') # 한 줄 주석입니다를 출력하는 코드

▶한꺼번에 여러 줄 주석: 단축키 ctrl + /
(IDE: PyCharm, vsCode 기준)

▶한꺼번에 여러 줄 주석 해제: 단축키 ctrl + /

(IDE: PyCharm, vsCode 기준)

▶ 범위 주석 (dogstrings) : ''' 작은따옴표 (또는 큰 따옴표) 3개를 시작과 끝에 작성합니다.

print('Python') # Python을 출력하는 코드
'''
Life is too short, 
you need python.
'''
print('Slogan') # Slogan을 출력하는 코드

🙌 여기서 잠깐!

파이썬에서 '(작은따옴표)와 "(큰따옴표) 사이에 차이가 없습니다.

하지만 열의 시작과 끝에 같은 종류의 따옴표를 사용해 주어야 합니다.

다음 포스팅인 출력 함수 부분에서 자세한 내용을 확인해 주세요♡

[Python]🐍 Print 함수

---

4. 주의사항⚠️

※ 범위 주석의 시작 줄과 마지막 줄에는 '''(또는 """) 외의 문자가 포함되지 않도록 해주세요!

print('Python') # Python을 출력하는 코드
''' Life is too short, 
you need python.'''
print('Slogan') # Slogan을 출력하는 코드

⚠️ Error⚠️범위 주석과 같은 라인에 문자 작성 시 에러 발생!

※ 범위 주석은 반드시 들여 쓰기를 해주세요!

def addNumbers(num1, num2, num3):
    '''
    :param num1: num1의 값
    :param num2: num2의 값
    :param num3: num3의 값
    :return: num 1, 2, 3의 합
    '''

👌 correct👌 파이썬은 들여 쓰기로 if, for, class, def 등의 범위 끝을 인식하게 되는데, 어느 함수의 주석인지를 구분하기 위해 주석도 들여 쓰기를 해야 합니다.

def addNumbers(num1, num2, num3):
'''
    :param num1: num1의 값 
    :param num2: num2의 값
    :param num3: num3의 값
    :return: num 1, 2, 3의 합
'''

⚠️ Error⚠️ IndentationError : expected an indented block after function definition on line 1

(들여 쓰기 오류 : 라인 1의 함수 정의 뒤에 들여 쓰기 된 블록이 필요합니다.)

#를 이용한 주석 처리 방법을 사용하는 것을 추천합니다. 범위 주석으로 여러 줄 주석 처리를 할 수 있더라도 왜냐하면 범위 주석의 주요 목적은 주석을 위한 것이 아닌 문서화를 하기 위한 것이기 때문입니다.

---

5. 핵심내용👀