brunch

You can make anything
by writing

C.S.Lewis

by 미래지기 Sep 18. 2024

코드에 설명 달기

@ | 골뱅이 / 앳 사인 | At Sign


  다음과 같은 코드가 있습니다.


c = input("나이를 입력하세요 : ")

i = int(c)

d = i * 365

print("태어난 지", d, "일이 지났습니다.")


위의 코드가 무슨 일을 하는 코드인지 한눈에 알아보실 수 있나요?


지난번에 본... 날짜 계산하는 거 아닌가요?


맞습니다. 나이를 입력하면 태어나서 지금까지 며칠을 살았는지 계산하는 파이썬 프로그랩입니다.


위의 코드를 직접 입력했거나 여러 번 봐서 익숙하다면 한 번에 보고 무슨 코드인지 알 수 있을 것입니다. 그러나 이 코드를 처음 보는 사람은 이해하기 어려울 수도 있습니다. 작성한 코드에 대한 안내 또는 설명이 있다면 코드를 이해하기 더 쉽겠지요. 이런 안내나 설명을 '주석'이라고 합니다.


주석   comment


파이썬에서 주석은 '#'라는 문자로 시작합니다.


x = a + b


이것은 코드입니다. 그런데 아래와 같이 코드 앞에 # 문자를 붙이면 이건 코드가 아니라 주석, 즉 설명문이 됩니다. 이렇게 하면 아무리 코드를 썼어도 코드로 취급하지 않습니다. 이건 설명일 뿐입니다.


# x = a + b




이제, 주석을 써서 위의 코드에 설명을 달아보겠습니다.


# 나이를 입력받습니다.

c = input("나이를 입력하세요 : ")


# 입력받은 문자를 숫자로 바꿉니다.

i = int(c)


# 입력받은 숫자에 365를 곱합니다.

d = i * 365


# 곱한 수를 출력합니다.

print("태어난 지", d, "일이 지났습니다.")


어떤가요? 주석 때문에 전체 코드의 양은 늘어났지만, 한 줄 한 줄 설명을 붙이니까 단계적으로 무엇을 하는지 쉽게 알 수 있지요?


'#' 문자 오른쪽에 쓰는 모든 내용은 주석이 되므로 아래와 같이 코드와 주석을 한 줄에 쓸 수도 있습니다.


c = input("나이를 입력하세요 : ") # 문자를 입력받습니다.

i = int(c) # 입력받은 문자를 숫자로 바꿉니다.

d = i * 365 # 입력받은 숫자에 365를 곱합니다.

print("태어난 지", d, "일이 지났습니다.") # 곱해서 얻은 수를 출력합니다.




# 문자로 주석을 쓰면 단 한 줄만 쓸 수 있습니다. 여러 줄의 주석을 한 번에 쓰기 위해서는 작은따옴표나 큰따옴표 3개를 써서 설명한 내용을 감싸주면 됩니다.


""" 또는 '''


여러 줄에 주석을 달아야 하니까 시작할 때 따옴표로 시작하고, 설명이 끝날 때도 따옴표를 마무리합니다.


아래는 여러 줄에 쓴 주석입니다.


'''

이 부분은 설명입니다.

코드가 아닙니다.

이 안에 코드를 써도 무시됩니다.

x = sin(30)

print(x)

설명이니까요.

'''




이제 위의 코드를 아주 자세하게 설명하는 주석을 달아보겠습니다.


"

<나이를 입력받아 살아온 날을 출력하는 프로그램>

언아 : Python

버전 : 1.0

만든 날짜 : 2024.9.18

"


# step 1 - 키보드를 통해 나이를 입력받는다.

c = input("나이를 입력하세요 : ")


# step 2 - 입력받은 내용은 문자이므로 숫자로 변환한다.

i = int(c)


# step 3 - 변환한 숫자 변수에 365를 곱하여 나이만큼 살아온 날을 계산한다.

d = i * 365


# step 4 - 계산된 결과를 화면에 출력한다.

print("태어난 지", d, "일이 지났습니다.")


어때요? 참, 쉽죠?


▨ 미래지기

이전 14화 숫자형, 문자형 그리고 불리언에 대하여
브런치는 최신 브라우저에 최적화 되어있습니다. IE chrome safari