파이썬 주석 사용법 간단하고 명료하게 설명 달기

주석을 어떻게 하용하느냐에 따라 프로그램의 완성도와 유지보수에 영향을 줄 수 있다. 코드만 있는 것보다는 주석으로 간단하고 명료하게 주석으로 설명문을 작성해 놓는다면 추후 재사용에도 편하다. 궁극적인 것은 만들어진 프로그램이 어떻게 동작하고 변수와 함수 등 어떤 목적으로 코딩이 되었는지 파악하는 것이다.

파이썬 주석 한줄 주석 여러줄 주석

 

주석 comment

주석은 모든 프로그래밍언어에서 사용한다.

만들어진 변수와 함수 등 사용하는 목적을 간단히 풀어서 작성해 둔다.

시간이 지나고 기억이 나지 않을 때 주석에 작성된 설명문은 도움이 크다.

파이썬 주석 또한 한 줄 주석과 여러 줄 주석을 사용할 수 있다.

차이가 있다면 한줄 주석은 #을 이용하고 여러줄 주석은 '''을 이용한다.

#한줄 주석

'''
여러 줄
주석
'''

 

한 줄 주석

파이썬에서 사용하는 한 줄 주석은 #을 사용한다.

한줄로 간단하게 설명을 작성하고자 할 때 사용하면 된다.

자신이 만든 변수의 용도나 함수의 용도를 간단히 작성하고자 한다면 #을 사용하여 주석으로써 설명을 작성할 수 있다.

#변수를 만들고 값을 할당한다.
vString = "안녕이라 말해요~" #문자열 변수에 값을 할당
vInt = 13                   #숫자 변수에 값을 할당

#변수값을 화면에 출력한다.
print(vString) #문자열 변수에 담긴 화면출력
print(vInt)    #숫자 변수에 담긴 화면출력

 

여러 줄 주석

#을 사용하여 설명을 추가했지만 여러 줄로 설명을 작성하고자 한다면 불편할 수 있다.

그렇기에 '''을 이용하여 여러 줄에 걸쳐 긴 설명을 작성할 수 있다.

보통 전체적인 코드의 목적이나 함수의 설명 등에 사용되며 코드의 버전관리를 위해 표현할 때도 사용된다.

어쨌든 시간이 지나고 추후에 코드를 쉽고 빠르게 파악하기 위한 것이 목적이다.

'''
변수를 만들고 값을 할당한 후
변수에 할당된 값을 화면에 출력한다.
'''

#변수를 만들고 값을 할당한다.
vString = "안녕이라 말해요~" #문자열 변수에 값을 할당
vInt = 13                   #숫자 변수에 값을 할당

#변수값을 화면에 출력한다.
print(vString) #문자열 변수에 담긴 화면출력
print(vInt)    #숫자 변수에 담긴 화면출력

 

주석은 아무리 길게 쓴다고 해도 컴파일할 때는 제외되며, 화면에 표시되지도 않는다.

그렇기에 설명을 작성할 때는 충분히 작성해도 되고 짧고 간단하고 명료하게 작성해도 된다.

개발자 마음이기도 한 부분이다.

하지만, 잘못 작성된 부분이 있다면 나중에 오류를 범할 수 있기 때문에 작성하고자 한다면 가급적 간단하고 명료하게 목적에 맞는 설명을 주석으로 작성하는 것이 좋다.