2023년 6월 업데이트
안녕하세요. SQLER의 코난 김대우입니다.
이번 강좌에서는, Python 초급 강좌 목차 - 3. 주석(Comments) 구문을 진행토록 하겠습니다.
SQLER에서 진행되는 전체 Python / 머신러닝 강좌 목록
코드를 실행하기 위해서는, vscode에서 새로운 파일을 만들고 실행하시면 됩니다.
예를 들어, 03_comment.py를 생성하고 코드를 실행합니다.
Python 초급 강좌 목차 - 3. 주석(Comments)
TL;DR
주석은 해시 문자(#)로 표시되며 코드를 문서화하는 데 사용됩니다. 코드가 실행될 때 주석 처리된 줄은 실행되지 않습니다. 주석은 다른 개발자에게 코드의 목적을 설명하거나 함수(function)에 대한 정보를 제공하는 경우에도 사용할 수 있습니다.
주석은 해시 문자(#)로 시작하며 코드를 문서화할 수 있습니다.
실행되면 주석으로 표시된 라인은 실행되지 않습니다.
일반적인 주석
# This is a comment in my code it does nothing
# 코드의 주석이고 코드는 동작하지 않습니다.
# print('Hello world')
# print("Hello world")
# 아무 결과도 출력되지 않습니다.
다른 개발자에게 코드의 목적을 설명
아래와 같은 enable_pin이라는 함수가 있을 때, 함수의 목적과 정보를 이렇게 주석으로 표시 가능합니다.
# enable_pin 메서드는 아직 코딩하지 않았습니다.
# 더미 메서드를 만들었으므로 코드는 오류 없이 실행됩니다.
# 코드를 잘 이해하지 못하더라도 당황할 필요 없습니다. 별도의 모듈에서 메서드를 다룰 예정입니다.
def enable_pin(user, pin):
print('pin enabled')
# current_user 및 pin 값을 설정하여 테스트 진행
current_user = 'TEST123'
pin = '123456'
# 보안 요구 사항에 나열된 대로 PIN 체크를 활성화하세요. - 코드를 잘 몰라도 놀랄 필요 없습니다.
enable_pin(current_user, pin)
또는, 이렇게 코드를 작성한 이유를 다른 개발자에게 설명할 수 있고, 디버깅에도 사용 가능합니다.
# 문자열 안에 작은따옴표가 포함되어 있으므로, 이 문자열에는 큰 따옴표를 사용합니다.
print("It's a small world after all")
멀티라인 comment를 아래와 같이 큰따옴표 3개를 연속해 사용 가능합니다.
"""
This is a comment
written in
more than just one line
"""
print("Hello, World!")
☑️ 챗GPT 활용: show python function comment example
참고링크
파이썬 강좌 책 구매
강좌가 도움이 되셨다면, 책으로 구매 가능합니다. 책 판매 수익금은 전액 코딩 교육 사회공헌 활동에 기부되며, 아래 링크에서 구매하시면 더 많은 금액이 기부됩니다.
책구매 링크: 챗GPT와 함께하는 파이썬 & 머신러닝 코딩 마스터
