더북(TheBook)

그러면 주석은 왜 필요할까요? 바로 코드를 읽는 사람이 이해하기 쉽도록 돕기 위해서입니다. 본인이 만든 코드라도 나중에 다시 보면 내가 쓴 것이 맞나 싶을 정도로 낯설 수 있습니다. 스스로 작성한 코드도 이렇게 의문스러울 때가 있는데, 다른 사람이 쓴 코드를 이해하기는 더욱 어려울 수 있습니다. 이때를 대비하여 이 코드가 무엇인지 기록해 두는 주석이 필요합니다.

이처럼 주석은 설명용으로 남길 때가 많기 때문에 그 내용이 길어질 수도 있습니다. 여러 줄의 문장을 주석 처리하는 방법은 작은따옴표(')를 세 번 쓰고 주석을 작성한 후 다시 똑같이 작은따옴표 세 개로 닫아 주는 것입니다. 작은따옴표 대신 큰따옴표(")를 세 번 사용할 수도 있습니다.

'''
프로그램 전체 설명이나
기능을 설명할 때는 써야 할 말이 많습니다.
'''

"""
이때는 주석을 이렇게 길게
사용합니다.
"""

상세하지만 간결한 주석을 남기는 습관을 길러 스스로가 만든 코드를 정리하는 동시에 다른 사람이 보았을 때도 코드를 이해할 수 있도록 합니다.

신간 소식 구독하기
뉴스레터에 가입하시고 이메일로 신간 소식을 받아 보세요.