Python의 주석 프로그램 실행 중에 인터프리터가 무시하는 코드 행입니다.
리눅스에서 디렉토리 이름을 바꾸는 방법
# I am single line comment> > > ''' Multi-line comment used> print('Python Comments') '''> |
>
>
주석은 코드의 가독성을 높이고 프로그래머가 코드를 매우 주의 깊게 이해할 수 있도록 도와줍니다. 또한 주석을 추가하면 코드를 더 쉽게 설명할 수 있으므로 다른 개발자와의 공동 작업에도 도움이 됩니다.
Python의 주석 유형
Python에는 세 가지 유형의 주석이 있습니다.
- 한 줄 코멘트
- 여러줄 주석
- 문자열 리터럴
- 독스트링 코멘트
Python의 주석
예를 들어 보면 다음과 같다. 파이썬 프로그램이 실행되는 동안 해석기는 주석을 무시합니다.
파이썬3
# sample comment> name>=> 'geeksforgeeks'> print>(name)> |
>
>
산출:
geeksforgeeks>
Python에서 주석이 사용되는 이유는 무엇입니까?
주석은 프로그래밍 언어의 필수적인 부분이었으며 모든 언어에는 주석을 사용하는 방법이 다릅니다.
다른 언어와 마찬가지로 Python의 주석도 다음과 같은 목적으로 사용됩니다.
- 코드 가독성 향상
- 다른 사람에게 코드 설명하기
- 시간이 지난 후 공부하면 코드 이해
- 기능의 단계와 요구사항 문서화
- 동료 개발자와 코드 공유
- 여러 사람과 협력합니다.
Python의 주석 유형
댓글의 다양한 유형과 사용 방법, 사용 시기를 알아볼까요?
1. 단선 코멘트
- Python 한 줄 주석은 공백 없이 해시태그 기호(#)로 시작하고 줄 끝까지 지속됩니다.
- 주석이 한 줄을 초과하면 다음 줄에 해시태그를 추가하고 Python 주석을 계속합니다.
- Python의 한 줄 주석은 변수, 함수 선언 및 표현식에 대한 간단한 설명을 제공하는 데 유용한 것으로 입증되었습니다. 한 줄 주석을 보여주는 다음 코드 조각을 참조하세요.
예:
파워셸과 배쉬
파이썬3
# Print techcodeview.com ! to console> print>(>'techcodeview.com'>)> |
>
>산출
techcodeview.com>
2. 여러 줄 주석
Python은 다음 옵션을 제공하지 않습니다. 여러 줄 주석 . 그러나 여러 줄의 주석을 작성할 수 있는 방법에는 여러 가지가 있습니다.
a) 여러 해시태그(#)를 사용한 여러 줄 댓글
Python에서 여러 줄의 주석을 작성하려면 여러 개의 해시태그(#)를 사용할 수 있습니다. 각 줄은 한 줄 주석으로 간주됩니다.
파이썬3
# Python program to demonstrate> # multiline comments> print>(>'Multiline comments'>)> |
>
>산출
Multiline comments>
또한 확인하십시오: Python 여러 줄 주석에 대한 흥미로운 사실
3. 문자열 리터럴
파이썬은 다음을 무시합니다. 문자열 리터럴 변수에 할당되지 않아 이러한 문자열 리터럴을 Python 주석으로 사용할 수 있습니다. .
a) 문자열 리터럴을 사용한 한 줄 주석
위의 코드를 실행하면 출력이 없다는 것을 알 수 있으므로 다음과 같이 문자열을 사용합니다. 삼중 따옴표 ()를 여러 줄 주석으로 사용합니다.
자바 문자열을 int로
파이썬3
'This will be ignored by Python'> |
>
>
b) 문자열 리터럴을 사용한 여러 줄 주석
파이썬3
''' Python program to demonstrate> >multiline comments'''> print>(>'Multiline comments'>)> |
>
>산출
Multiline comments>
4. 독스트링
- 파이썬 독스트링 함수 바로 뒤에 나타나는 삼중따옴표가 있는 문자열 리터럴입니다.
- Python 모듈, 함수, 클래스 및 메서드로 작성된 문서를 연결하는 데 사용됩니다.
- 함수, 모듈 또는 클래스 바로 아래에 추가되어 해당 기능이 무엇인지 설명합니다. Python에서는 __doc__ 속성을 통해 독스트링을 사용할 수 있습니다.
예:
파이썬3
행운을 빌어요
def> multiply(a, b):> >'''Multiplies the value of a and b'''> >return> a>*>b> > > # Print the docstring of multiply function> print>(multiply.__doc__)> |
>
>
산출:
Multiplies the value of a and b>
Python 주석의 장점
댓글은 일반적으로 다음과 같은 목적으로 사용됩니다.
- 코드 가독성
- 프로젝트의 코드 또는 메타데이터에 대한 설명
- 코드 실행 방지
- 리소스를 포함하려면
댓글을 작성하는 올바른 방법
주석은 코드를 설명하는 주요 목적으로 사용됩니다. 개발자는 코드를 더 잘 이해하기 위해 건전한 주석 작성 방법을 사용합니다.
귀하의 의견을 효과적으로 만들기 위해 따라야 할 몇 가지 팁은 다음과 같습니다.
- 댓글은 짧고 정확해야 합니다.
- 필요한 경우에만 주석을 사용하고 주석으로 코드를 복잡하게 만들지 마십시오.
- 댓글에는 어떤 의미가 있어야 합니다.
- 일반적이거나 기본적인 댓글은 작성하지 마세요.
- 설명이 필요 없는 댓글을 작성하세요.
우리는 Python 주석, Python 주석 작성 방법, 주석 유형, 장점 및 주석 작성 올바른 방법에 대해 모두 논의했습니다.
또한 읽어보세요: Python3에서 주석을 작성하는 방법은 무엇입니까?