Devices

【 파이썬 】 주석

작성자 임베디드코리아 작성일26-02-01 18:24 조회25회 댓글0건
< * 파이썬 주석 * >
◆ 파이썬 주석은 코드에 설명을 추가하여 가독성을 높이고 실행에 영향을 주지 않도록 하는 기능다
◆ 주로 소스 코드를 읽는 사람들을 위해 주석을 남기는 용도로 빈번하게 사용된다.
◆ 한 줄은 # 기호를 사용하고, 여러 줄은 작은따옴표(''')나 큰따옴표(""") 3개를 사용한다.
    - 들여쓰기나  4칸 들여쓰기(또는 Tab 키)를 사용하면 들여쓰기 에러가 발생할 수 있다.
예제:
        print 'hello Embedded Korea'  # Note that print is a statement
 
예제:
        # Note that print is a statement
        print 'hello Emedeed Korea'

예제:
# print("Hello Embedded")
print("Hello korea")
<출력 결과>
Hello korea

Python에는 JavaScript, Java, C++ 등의  다른 프로그래밍 언어들과 다르게 여러 줄 주석 처리시 /*...*/를 사용하지 않는다.
Python에서 여러 줄로 주석 처리를 하기 위해 각 줄마다 맨 앞에 해시(#)를 붙일 수 있다.

예제:
# print("Hello world")
# print("Hello Embeeede")
# print("Hello Korea")

print("embeddedkorea.co.kr")
<출력 결과>
embeddedkorea.co.kr

◆ Python에서 여러 줄 주석을 만들기 위한 진정한 대안은 독스트링(docstrings) 을 사용한다.

예제:
"""
**  docstrings **

print("Hello world")
print("Hello Embeeede")
print("Hello Korea")
"""

print("embeddedkorea.co.kr")
<출력 결과>
embeddedkorea.co.kr


◆ 프로그램을 작성할 때, 주석을 가능한 많이 사용하는 것이 좋다.
  • 미리 가정하고 넘어간 것들에 대한 설명
  • 중요한 결정 사항에 대한 설명
  • 중요한 세부 사항에 대한 설명
  • 해결하고자 하는 문제에 대한 설명
  • 앞으로 극복하려고 하는 문제들에 대한 설명 등등.

☞ 주석은 프로그램을 읽는 사람들에게 프로그램이 무엇을 하는 프로그램 인지
    쉽게 파악할 수 있도록 도움을 주는 역할을 한다.
☞ 주석을 한글로 남길 경우, 혹은 여러분의 파이썬 프로그램에 한글이 들어갈 경우
    프로그램의 첫 번째 줄 혹은 두 번째 줄_에는 반드시 다음과 같이 파일의 인코딩에 대한
    정보가 주석의 형태로 들어가 있어야 한다.