[파이썬 입문 2-5] 주석

1. 주석(Comment)이란?

짧게 짧게 코드를 작성하는 경우에는 별도의 메모를 하지 않더라도 내가 이 코드를 왜 이렇게 썼는지 알고 있다.
하지만 코드의 양이 방대해지게 된다면 '내가 이때 왜 이렇게 썼더라?' 라던지, '이게 뭐였더라'하는 순간이 찾아올 수 있습니다.

이럴때 추가 설명 혹은 부연 설명을 적어 놓는다면 나뿐만 아니라 다른 누군가와 함께 코드를 작성하는 경우에도 서로 이해할 수 있게 될것이다.
이런 경우에 주석(comment)을 사용하면 좋다.

주석은 보통 코드가 어떤 내용을 포함하고 있는지, 이 문장이 의미하는 것은 무엇인지, 왜 이렇게 썼는지, 주의해야할 점은 무엇인지, 추가로 알아야 할 내용은 무엇인지 등을 설명해야 할 때 사용한다.

주석은 프로그램 안에 작성하지만, 프로그램을 실행하는 데 아무런 영향을 끼치지 않는다.
하지만 개발자에게는 코드의 의미를 전달하는 아주 큰 역할을 한다.

이전에 작성했던 예시 코드를 다시 살펴보도록 하자.

print(int(3.5))

# 출력 결과
# 3

VScode상의 터미널을 캡쳐해서 공부의 내용을 올리는게 아닌 주석을 사용하여 출력 결과를 표기하였다.
이것을 좀 더 활용해서 적어본다면

print(int(3.5))

# 출력 결과
# 3
# 소수점 아래 숫자들은 반올림도 아니고 버림처리 되었음.

위와 같이 표기하여 메모를 적어놓을 수도 있다.

# print(float(3.5))
print(float(3))
# float()는 실수형으로 바꾸는 형변환

# 출력 결과
# 3.0
# 3.0은 print(float(3))에 대한 결과값이다.

위 코드처럼 print()문에 주석처리를 하면 출력 결과가 나타나지 않게 된다.

#의 경우 한 줄만 주석처리가 가능하다.
하지만 여러줄을 한꺼번에 주석처리 하고 싶으면 모든 줄에다가 #을 붙여야할까?

이럴때는 따옴표 3개(큰 따옴표 또는 작은 따옴표)를 사용하면 여러 줄을 한꺼번에 주석처리할 수 있다.

animal = "개"
name = "해피"
age = 4
hobby = "낮잠"

print("반려동물을 소개해 주세요")

"""
print("우리 집 반려동물은 "+animal+"인데, 이름은 " + name + "입니다.")

hobby = "수영"

print(name + "는 " + str(age) + "살이고, " + hobby + "을 아주 좋아해요")
print(name + "는 암컷인가요?")
print("네")
"""

# 출력 결과
# 반려동물을 소개해 주세요

큰 따옴표로 감싼 코드 부분이 모두 주석처리 되어서 출력 결과로 '반려동물을 소개해 주세요'만 출력되었다.

2. VSCode의 주석 단축키

VSCode에서 주석을 단축키로 설정할 수 있다.
한 줄 전체를 주석처리할 때는 문장 아무곳에나 커서를 두고 Command + / 를 누르면 된다.
추가로 여러 줄을 추석처리할 때는 마우스로 해당 영역을 드래그하거나 Shift + 방향키로 영역을 지정할 수 있다.