Computer >> 컴퓨터 >  >> 프로그램 작성 >> Python

Python 주석:단계별 가이드

파이썬 주석은 인터프리터에 의해 실행되지 않는 프로그램의 한 줄의 텍스트입니다. 주석은 디버깅 중에 문제를 식별하고 코드를 설명하는 데 사용됩니다. 댓글은 해시 문자(#)로 시작합니다.

Python에서 주석 처리하는 방법

주석은 Python에서 실행하지 않을 메모나 코드를 나타냅니다. 예를 들어, 몇 시간 동안 복잡한 절차를 작성한다고 가정해 보겠습니다. 추적을 잃지 않도록 코드의 각 행이 수행하는 작업을 추적하기 위해 몇 가지 주석을 작성할 수 있습니다.

댓글 작성은 여러 가지 이유로 유용합니다. 큰 Python 프로그램으로 작업하는 경우 주석을 추가하면 진행 상황을 추적하는 데 도움이 될 수 있습니다. 댓글을 작성하면 팀원 모두가 공동 작업 프로젝트에서 서로의 작업을 이해하는 데 도움이 됩니다.

모든 개발자는 결국 코드를 ​​작성할 때 주석을 포함해야 하는 상황에 직면하게 됩니다.

그러나 Python에서 코드에 대해 어떻게 설명합니까? 다른 모든 프로그래밍 언어와 마찬가지로 Python은 주석 달기를 지원합니다. 이 가이드에서는 Python으로 주석을 작성하는 방법에 대해 설명합니다.

파이썬 주석이란 무엇입니까?

파이썬 주석은 프로그램에 나타나지만 프로그램에 의해 실행되지 않는 한 줄의 텍스트입니다. 해시태그(#)를 사용하여 댓글을 선언할 수 있습니다. 주석은 새 줄이나 기존 코드 줄 끝에 나타날 수 있습니다.

주석은 코드 작동 방식을 설명하고 테스트 목적으로 사용됩니다.

다음은 Python의 한 줄 주석의 예입니다.

참가자의 81%는 부트캠프에 참석한 후 기술 직업 전망에 대해 더 자신감을 느꼈다고 말했습니다. 지금 부트캠프에 참여하십시오.

부트캠프 졸업생은 부트캠프 시작부터 첫 직장을 찾는 데까지 6개월도 채 걸리지 않았습니다.

# This is a demo comment

# 해시 표시가 우리의 주석을 나타내는 것을 볼 수 있습니다. 주석 텍스트와 # 기호를 공백으로 구분했습니다. 이것은 필수는 아니지만 각 댓글을 읽기 쉽게 만듭니다.

이 줄은 우리가 코드를 실행할 때 컴파일러에서 무시됩니다. 댓글은 사람이 읽어야 합니다. 프로그램을 실행하기 위한 것이 아닙니다.

주석은 주석이 참조하는 코드와 동일한 들여쓰기 수준에서 추가되어야 합니다. 예를 들어 if 내의 코드 줄에 대해 작성한다고 가정해 보겠습니다. 성명. 코드와 동일한 방식으로 주석을 들여씁니다.

파이썬 주석 예시

for 루프를 작성 중이고 어떻게 작동하는지 스스로에게 상기시키고 싶다고 가정해 보겠습니다. 몇 가지 의견을 작성하고 싶을 수도 있습니다. 나중에 코드를 보기 위해 다시 돌아올 때 메모를 읽을 수 있습니다.

Python for 루프에는 다음과 같은 주석이 있을 수 있습니다.

# Define students variable as an array of strings
students = ["Nathan", "Alyssa", "Matthew", "Malcolm", "Alexis", "Katie"]

# Loop through each item in the students array and print out each name
for s in students:
	print("Student Name: ", s)

우리의 의견은 코드의 목적을 이해하고 진행 상황을 추적하는 데 도움이 됩니다.

Python에서 주석의 들여쓰기 구조를 설명하기 위해 예제를 사용하겠습니다. 아래 예에서 우리 프로그램은 두 개의 Python 배열을 반복하고 각 학생에게 통과를 제공합니다. 또는 실패 그들의 테스트를 위해. 합격 및 불합격은 학생의 시험 점수에 따라 결정됩니다.

# Define an array with student names
students = ["Nathan", "Alyssa", "Matthew", "Malcolm", "Alexis", "Katie"]

# Define an array with student grades
numericalGrades = [55, 72, 64, 86, 86, 59]

# Loop through every student in "students" array
for s in range(0, len(students)):
	# Check if the student's numerical grade is equal to or above 60
if numericalGrades[s] >= 60:
	# Print a message saying the student has passed their test
print(students[s], "passed their test.")
else:
	# Print a message saying the student has failed their test
print(students[s], "failed their test.")

이 프로그램은 학생 목록과 성적을 받습니다. 그런 다음 우리 프로그램은 학생 목록을 반복합니다. 각 학생이 시험을 통과했는지 또는 불합격했는지 확인합니다.

위의 예에서 우리가 참조하는 줄과 동일한 들여쓰기 수준에 대해 주석을 다는 것을 볼 수 있습니다. 예를 들어 Python if 문에 대해 논의할 때 코드와 함께 주석을 들여쓰기했습니다.

이러한 한 줄 주석을 작성함으로써 우리 프로그램은 코드 작성자 모두에게 더 읽기 쉽습니다. 또한 우리 프로그램을 보는 모든 사람이 더 쉽게 읽을 수 있습니다.

Python 인라인 주석

Python 인라인 주석은 코드가 작성된 후 명령문과 같은 줄에 작성됩니다. 인라인 주석은 코드 줄의 목적이나 작동 방식을 설명해야 합니다.

인라인 주석 구문은 다음과 같습니다.

print(students) # Print the variable "students"

인라인 주석은 코드의 복잡한 부분을 설명해야 하는 경우에 유용합니다. 나중에 특정 코드 라인이 작동하는 방식을 잊어버릴 수 있다고 생각되는 경우에도 유용합니다.

인라인 댓글은 팀에서 일하고 모든 사람이 특정 라인을 이해하도록 해야 하는 경우에도 유용합니다.

다른 유형의 주석과 달리 인라인 주석만 가끔 사용하십시오. 인라인 주석이 너무 많으면 프로그램을 읽기가 어렵기 때문입니다.

Python 여러 줄 주석

Python 여러 줄 주석 또는 Python 블록 주석은 더 복잡하거나 목적이 즉시 명확하지 않은 코드를 설명합니다. 예를 들어 외부 라이브러리를 사용하는 고유한 기능을 설명하기 위해 블록 주석을 사용할 수 있습니다.

블록 주석은 Python의 여러 줄 주석이며 그 아래의 일부 또는 전체 코드에 적용됩니다. 다른 주석과 마찬가지로 차단 주석도 주석이 논의 중인 코드와 동일한 수준에서 들여쓰기됩니다.

여러 줄 주석 예

다음은 Python sort() 함수를 설명하는 여러 줄 문자열의 예입니다.

# The sortStudents function will parse arguments via the "student" variable. The
# function simply returns the length of each student's name. We reference the sortStudents
# function in the sort() function later in the code, which iterates over each item in the
# "students" array and executes our sortStudents function.

def sortStudents(student):
	return len(student)

students = ["Nathan", "Alyssa", "Matthew", "Malcolm", "Alexis", "Katie"]

students.sort(key=sortStudents)

우리의 주석은 여러 줄에 걸쳐 있으며 그 아래에 작성된 코드의 목적을 설명합니다.

일부 개발자는 이 코드를 이해할 수 있지만 다른 프로그래머는 작동 방식이나 작성된 이유에 대해 혼동할 수 있습니다. 블록 주석을 사용하면 전체 절차를 설명할 수 있습니다. 블록 주석은 목적이 개발자에게 즉시 명확하지 않은 다른 코드를 설명하는 데 유용합니다.

결론

이것이 Python에서 주석을 작성하는 방법입니다! 주석을 사용하면 자신을 포함한 모든 사람이 프로그램을 더 쉽게 읽을 수 있습니다.

잘 작성된 주석은 진행하면서 코드를 추적하는 데 도움이 될 수 있습니다. 나중에 코드를 이해하는 데 어려움을 겪을 때 나중에 다시 참조할 수 있는 기록을 유지할 수 있습니다.

도전할 준비가 되었나요? 프로그램 중 하나의 상단에 블록 주석을 작성하십시오. 이 의견에는 다음이 포함되어야 합니다.

  • 이름
  • 파일을 만들 때
  • 파일 이름
  • 파일의 목적

코드를 실행해 보십시오. 주석 때문에 프로그램이 실행되지 않으면 오류가 발생한 것입니다. 프로그램이 정상적으로 실행되면 축하합니다! 댓글을 성공적으로 작성하셨습니다.

이 자습서에서는 Python에서 주석을 작성하고 주석을 인라인하고 주석을 차단하는 방법을 살펴보았습니다. 또한 일부 개발자가 테스트를 위해 주석을 작성하는 방법에 대해서도 논의했습니다. 이제 Python 전문가처럼 댓글을 작성할 수 있습니다!

Python 프로그래밍 언어를 마스터하고 싶으십니까? 최고의 Python 과정, 책 및 학습 리소스에 대한 지원은 포괄적인 Python 학습 방법 가이드를 확인하세요.