본 실습에서는 Python 에서 주석 (comments) 의 중요성과 실제 적용 방법을 학습합니다. 주석은 코드를 이해하기 쉽게 만드는 데 필수적이며, 이는 코드 유지보수 및 협업에 매우 중요합니다. 단일 행 주석과 다중 행 주석을 포함하여 다양한 유형의 주석을 탐색하고, 코드 가독성을 향상시키기 위해 이를 효과적으로 사용하는 방법을 배웁니다.
주석은 Python 인터프리터가 무시하지만, 코드를 읽는 사람에게는 매우 유용한 코드 내의 메모입니다. 주석은 코드의 논리, 목적 및 명확하지 않은 세부 사항을 설명하는 데 도움이 됩니다. 기계가 코드를 실행하지만, 코드를 읽고 유지보수하는 것은 사람입니다. 깔끔하고 이해하기 쉬운 프로그램을 작성하려면 좋은 주석 습관이 필수적입니다.
주석이 없는 간단한 스크립트부터 시작하겠습니다. WebIDE 에서 왼쪽 패널의 파일 탐색기에서 purpose.py 파일을 찾아 엽니다.
purpose.py 파일에 다음 코드를 추가합니다.
x = 10
y = 20
z = x + y
print(z)Ctrl + S를 눌러 파일을 저장합니다.
스크립트를 실행하려면 상단 메뉴로 이동하여 Terminal -> New Terminal을 선택하여 WebIDE 에서 통합 터미널을 엽니다. 터미널은 화면 하단에 열리며 기본 경로는 ~/project입니다.
터미널에서 다음 명령을 실행하여 스크립트를 실행합니다.
python purpose.py계산 결과를 다음과 같이 볼 수 있습니다.
30이 스크립트는 간단하지만, 더 큰 프로그램에서는 x, y, z가 무엇을 나타내는지 즉시 명확하지 않을 수 있습니다. 다음 단계에서는 이 코드를 더 쉽게 이해할 수 있도록 주석을 추가할 것입니다.
단일 행 주석 (Single-line comments) 은 짧고 설명적인 메모에 사용됩니다. Python 에서 단일 행 주석은 해시 기호 (#) 로 시작합니다. 인터프리터는 # 뒤에 오는 줄의 모든 내용을 무시합니다. 이 주석은 아래 코드를 설명하기 위해 별도의 줄에 배치하거나, 해당 구문을 설명하기 위해 같은 줄에 배치할 수 있습니다.
purpose.py 파일을 수정하여 단일 행 주석을 포함해 보겠습니다. 편집기에서 purpose.py를 열고 내용을 다음으로 업데이트합니다.
## This script calculates the sum of two numbers
x = 10 ## Assign the integer 10 to variable x
y = 20 ## Assign the integer 20 to variable y
z = x + y ## Calculate the sum of x and y
print(z) ## Print the final result to the console파일을 저장 (Ctrl + S) 하고 터미널에서 다시 실행합니다.
python purpose.py출력은 이전과 동일합니다.
30보시다시피 주석은 프로그램의 동작을 변경하지 않았습니다. 하지만 코드가 훨씬 더 읽기 쉬워졌습니다. 첫 번째 주석은 스크립트의 전체 목적을 설명하고, 인라인 주석은 각 줄의 역할을 명확히 합니다.
여러 행에 걸쳐 설명해야 하는 더 긴 설명의 경우, 여러 행 주석 형식을 사용할 수 있습니다. 다른 일부 언어와 달리 Python 에는 여러 행 주석을 위한 특정 구문이 없지만, 이 목적으로 여러 행 문자열 (multi-line strings) 을 사용할 수 있습니다.
여러 행 문자열은 텍스트를 세 개의 따옴표 ("""...""" (큰따옴표 세 개) 또는 '''...''' (작은따옴표 세 개)) 로 묶어 생성됩니다. 이 여러 행 문자열이 변수에 할당되지 않으면 Python 인터프리터는 이를 무시하며, 이는 사실상 주석 역할을 합니다. 이는 파일 시작 부분이나 복잡한 함수 앞에 자세한 설명을 제공할 때 매우 유용한 기법입니다.
WebIDE 에서 multiline.py 파일을 찾아 엽니다. 다음 코드를 추가합니다.
"""
This is a multi-line comment using triple double quotes.
This script demonstrates how to write comments that span
several lines to provide more detailed explanations.
"""
message = "Hello, Python learners!"
print(message)파일을 저장하고 터미널에서 실행합니다.
python multiline.py다음과 같은 출력을 보게 됩니다.
Hello, Python learners!세 개의 따옴표 안의 텍스트 블록은 무시되었고, print 구문만 실행되었습니다. 이 기법은 파일 시작 부분이나 복잡한 함수 앞에 자세한 설명을 제공할 때 매우 유용합니다.
Python 은 선언 주석 (declaration comments) 으로 알려진 특수 주석도 지원합니다. 이 주석들은 스크립트 실행 방식을 구성하기 위해 인터프리터나 운영 체제에 의해 처리됩니다. 두 가지 일반적인 예는 셔뱅 (shebang) 과 인코딩 선언입니다.
셔뱅 (#!): 셔뱅 줄은 스크립트의 맨 첫 줄입니다. 이는 Unix 계열 운영 체제에 해당 파일을 실행하는 데 사용할 인터프리터를 알려줍니다. Python 3 스크립트의 경우, 일반적으로 #!/usr/bin/python3입니다. 이를 통해 스크립트를 독립 실행 파일처럼 실행할 수 있습니다.
인코딩 선언 (Encoding Declaration): 이 주석은 Python 인터프리터에게 소스 파일에 사용할 문자 인코딩을 알려줍니다. 코드에 ASCII 가 아닌 문자 (non-ASCII characters) 가 포함된 경우 중요합니다. UTF-8 에 대한 표준 선언은 ## -*- coding: utf-8 -*-입니다. 이 주석은 파일의 첫 번째 또는 두 번째 줄에 위치해야 합니다.
두 가지 모두 사용하는 스크립트를 만들어 보겠습니다. 편집기에서 declaration.py 파일을 열고 다음 코드를 추가합니다.
#!/usr/bin/python3
## -*- coding: utf-8 -*-
## This script demonstrates declaration comments and non-ASCII characters.
print("Hello, World!")
print("你好，世界！") ## A greeting in Chinese파일을 저장합니다. 이 스크립트를 직접 실행하려면 먼저 실행 권한을 부여해야 합니다. 터미널에서 chmod 명령을 실행합니다.
chmod +x declaration.py이제 python을 먼저 입력하지 않고도 스크립트를 직접 실행할 수 있습니다.
./declaration.py출력은 중국어 문자를 포함하여 두 줄의 텍스트를 모두 올바르게 표시합니다.
Hello, World!
你好, 世界!셔뱅 줄 덕분에 시스템이 Python 3 인터프리터를 찾아서 사용할 수 있었고, 인코딩 선언 덕분에 ASCII 가 아닌 문자들이 올바르게 처리되었습니다.
본 실습 (lab) 에서는 Python 코드에 주석을 추가하는 방법을 배웠습니다. 간략한 메모를 위한 #을 사용한 한 줄 주석, 더 긴 설명을 위한 """..."""를 사용한 여러 행 주석, 그리고 스크립트 실행을 구성하기 위한 셔뱅 및 인코딩 선언과 같은 특수 선언 주석을 연습했습니다. 코드를 효과적으로 주석 처리함으로써 코드의 가독성, 유지보수성 및 다른 사람 (그리고 미래의 자신) 이 이해하기 쉽게 만들 수 있습니다.
