[Python] 파이썬 주석 정복하기 (필수)

목 차

• 1. 주석이란 (comment) ?
• 2. Docstring이란?

728x90

 

1. 주석이란 (comment) ?

소스 코드 내에 설명을 작성해 둔 부분을 말합니다. 주석은 프로그램 실행시 전혀 영향을 주지 않습니다.

​

1) 한 줄 설명 작성시 : # (내용)

def welcome () :
    print("Hello Bambi") # 한 줄 설명 작성 방법 

# 한 줄 설명 작성 방법
welcome()

 

2) 여러줄 설명 작성시 : ''' (내용) ''' 또는 """ (내용) """

'''
    파일명 : test.py
    프로그램명 : 테스트
    작성자 : bambi
    최초작성일 : 2024-08-19
'''

"""
    환영 인사 출력 함수
"""
def welcome () :
    print("Hello Bambi")

welcome()

 

작은 따옴표 (''')로 작성된 주석과 큰 따옴표 (""") 로 작성된 주석은 똑같은 주석 기능을 합니다. 하지만 큰 따옴표 (""")로 작성된 주석은 본래 Docstring을 작성하는 기능이기 때문에 구분해서 사용하는 것이 좋습니다.

​

 

 

2. Docstring이란?

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

 

def welcome () :
    """ 환영 인사 출력 함수 """
    print("Hello Bambi")

welcome()
print(welcome.__doc__)

# 실행 결과
# Hello Bambi
# 환영 인사 출력 함수