파이썬 주석(comment)은 프로그램 안에 작성되지만 인터프리터가 실행하지 않는 텍스트입니다. 주석은 디버깅 과정에서 문제를 파악하거나 코드를 설명할 때 활용되며, 해시 문자(#)로 시작합니다.
파이썬에서 주석을 다는 방법
주석은 파이썬이 실행하지 않기를 원하는 메모나 코드를 표시하는 데 사용됩니다. 예를 들어, 몇 시간에 걸쳐 복잡한 로직을 작성한다고 가정해 보겠습니다. 각 코드 줄이 어떤 역할을 하는지 잊어버리지 않도록 몇 줄의 주석을 남겨두면 큰 도움이 됩니다.
주석을 작성하면 여러 모로 유용합니다. 규모가 큰 파이썬 프로그램을 다룰 때는 주석 덕분에 전체 흐름을 놓치지 않고 따라갈 수 있습니다. 또한 협업 프로젝트에서는 팀원들이 서로의 작업 내용을 이해하는 데에도 주석이 중요한 역할을 합니다.
결국 모든 개발자는 코드를 작성하면서 반드시 주석을 달아야 하는 상황을 마주하게 됩니다.
그렇다면 파이썬에서는 코드에 어떻게 주석을 달까요? 다른 프로그래밍 언어와 마찬가지로 파이썬도 주석 작성을 지원합니다. 이 가이드에서는 파이썬에서 주석을 작성하는 방법을 자세히 살펴보겠습니다.
파이썬 주석이란?
파이썬 주석은 프로그램에 포함되지만 실제로는 실행되지 않는 텍스트 줄입니다. 해시(#) 기호를 사용해 주석을 선언할 수 있으며, 주석은 새로운 줄에 작성하거나 기존 코드 줄 끝에 붙여 쓸 수 있습니다.
주석은 코드가 어떻게 동작하는지 설명하거나 테스트 목적으로 활용됩니다.
다음은 파이썬 한 줄 주석의 예시입니다:
# This is a demo comment
# 기호가 주석임을 나타냅니다. # 기호와 주석 텍스트 사이에 공백을 하나 넣었는데, 필수 사항은 아니지만 주석을 훨씬 읽기 쉽게 만들어 줍니다.
코드를 실행하면 이 줄은 인터프리터가 무시합니다. 주석은 사람이 읽기 위한 것이지 프로그램이 실행하기 위한 것이 아닙니다.
주석은 해당 주석이 설명하는 코드와 같은 들여쓰기 수준에 맞춰 작성해야 합니다. 예를 들어 if 문 안의 코드에 대해 설명하는 주석이라면, 코드와 동일하게 들여쓰기를 적용해야 합니다.
파이썬 주석 예제
for 루프를 작성하면서 나중에 그 동작 방식을 잊지 않도록 메모를 남기고 싶다고 가정해 보겠습니다. 몇 줄의 주석을 미리 작성해 두면, 나중에 코드를 다시 볼 때 소중한 참고 자료가 됩니다.
파이썬 for 루프에서 주석은 다음과 같이 작성할 수 있습니다:
# students 변수를 문자열 배열로 정의
students = ["Nathan", "Alyssa", "Matthew", "Malcolm", "Alexis", "Katie"]
# students 배열의 각 항목을 순회하며 이름 출력
for s in students:
print("Student Name: ", s)
주석 덕분에 코드의 목적을 쉽게 이해하고 전체 흐름을 파악할 수 있습니다.
이번에는 파이썬에서 주석의 들여쓰기 구조를 보여주는 예제를 살펴보겠습니다. 아래 프로그램은 두 개의 배열을 순회하며 각 학생에게 시험 결과로 '합격' 또는 '불합격'을 부여합니다. 합격 여부는 학생의 시험 점수를 기준으로 판정됩니다:
# 학생 이름 배열 정의 students = ["Nathan", "Alyssa", "Matthew", "Malcolm", "Alexis", "Katie"] # 학생 점수 배열 정의 numericalGrades = [55, 72, 64, 86, 86, 59] # students 배열의 모든 학생을 순회 for s in range(0, len(students)): # 학생의 점수가 60점 이상인지 확인 if numericalGrades[s] >= 60: # 학생이 시험에 합격했다는 메시지 출력 print(students[s], "passed their test.") else: # 학생이 시험에 불합격했다는 메시지 출력 print(students[s], "failed their test.")
이 프로그램은 학생 명단과 점수 리스트를 받아 학생들을 순회하며, 각 학생이 시험에 합격했는지 불합격했는지 확인합니다.
위 예제에서 주석이 설명하는 코드와 동일한 들여쓰기 수준으로 작성된 것을 확인할 수 있습니다. 예를 들어 if 문에 대해 설명할 때는 주석과 코드 모두 같은 수준으로 들여썼습니다.
이렇게 한 줄 주석을 잘 활용하면 코드 작성자 본인은 물론, 프로그램을 처음 보는 다른 사람도 코드를 훨씬 쉽게 읽을 수 있습니다.
파이썬 인라인 주석
인라인 주석(inline comment)은 코드가 작성된 같은 줄에, 코드 뒤에 붙여 쓰는 주석입니다. 인라인 주석은 해당 코드 줄의 목적이나 동작 방식을 설명하는 데 사용해야 합니다.
인라인 주석의 문법은 다음과 같습니다:
print(students) # "students" 변수 출력
인라인 주석은 코드의 복잡한 부분을 설명해야 할 때 유용합니다. 특정 코드 줄의 동작 방식을 나중에 잊어버릴까 걱정될 때도 도움이 되며, 팀으로 일할 때 모든 구성원이 특정 줄을 이해하도록 보장해야 할 때도 유용합니다.
다만 다른 종류의 주석과 달리, 인라인 주석은 꼭 필요할 때만 사용하는 것이 좋습니다. 인라인 주석이 너무 많으면 오히려 프로그램을 읽기 어려워지기 때문입니다.
파이썬 여러 줄 주석(블록 주석)
여러 줄 주석(multiline comment), 즉 블록 주석(block comment)은 더 복잡하거나 목적이 한눈에 드러나지 않는 코드를 설명할 때 사용합니다. 예를 들어 외부 라이브러리를 활용하는 특수한 함수를 설명할 때 블록 주석을 사용할 수 있습니다.
블록 주석은 파이썬에서 여러 줄에 걸쳐 작성되는 주석으로, 그 아래에 있는 코드 일부 또는 전체에 적용됩니다. 다른 주석과 마찬가지로 블록 주석 역시 설명하는 코드와 같은 들여쓰기 수준에 맞춰 작성합니다.
여러 줄 주석 예제
다음은 파이썬 sort() 함수를 설명하는 여러 줄 주석의 예시입니다:
# sortStudents 함수는 "student" 변수를 통해 인자를 받아 처리합니다. # 이 함수는 각 학생 이름의 길이를 반환합니다. 코드 뒷부분의 sort() # 함수에서 sortStudents 함수를 참조하며, sort() 함수는 "students" # 배열의 각 항목을 순회하며 sortStudents 함수를 실행합니다. def sortStudents(student): return len(student) students = ["Nathan", "Alyssa", "Matthew", "Malcolm", "Alexis", "Katie"] students.sort(key=sortStudents)
주석이 여러 줄에 걸쳐 작성되어 있으며, 그 아래에 있는 코드의 목적을 설명하고 있습니다.
일부 개발자는 이 코드를 바로 이해할 수 있지만, 다른 프로그래머는 동작 방식이나 작성 이유를 혼란스러워할 수 있습니다. 블록 주석을 사용하면 절차 전체를 깔끔하게 설명할 수 있으며, 개발자가 한눈에 파악하기 어려운 코드를 설명하는 데 매우 유용합니다.
마무리
지금까지 파이썬에서 주석을 다는 방법을 알아보았습니다! 주석을 활용하면 본인을 포함해 모든 사람이 프로그램을 더 쉽게 읽을 수 있습니다.
잘 작성된 주석은 코딩 과정에서 코드를 체계적으로 관리하는 데 도움을 주며, 나중에 코드를 이해하기 어려울 때 다시 참조할 수 있는 소중한 기록으로 남습니다.
간단한 도전 과제를 하나 드리겠습니다. 여러분의 프로그램 맨 위에 블록 주석을 작성해 보세요. 이 주석에는 다음 내용이 포함되어야 합니다:
- 작성자 이름
- 파일 생성 날짜
- 파일 이름
- 파일의 용도
코드를 실행해 보세요. 주석 때문에 프로그램이 실행되지 않는다면 무언가 오류가 있는 것입니다. 프로그램이 정상적으로 실행된다면 축하합니다! 성공적으로 주석을 작성한 것입니다.
이 튜토리얼에서는 파이썬에서 주석, 인라인 주석, 블록 주석을 작성하는 방법을 살펴보았습니다. 또한 일부 개발자가 테스트 목적으로 주석을 활용하는 방법도 함께 다루었습니다. 이제 여러분도 파이썬 전문가처럼 주석을 작성할 수 있습니다!
파이썬 프로그래밍을 마스터하고 싶으신가요? 최고의 파이썬 강좌, 도서, 학습 자료에 대한 정보가 필요하다면 포괄적인 '파이썬 학습 가이드'를 확인해 보세요.