Python Comments: 파이썬 주석

이 자습서에서는 코드에 주석을 추가하는 방법을 배웁니다. 그리고 블록 주석, 인라인 주석 및 문서 문자열을 포함한 다양한 종류의 Python 주석을 배우게 됩니다.

 

1. Introduction to Python comments

작성하는 코드를 문서화하고 싶을 때가 있습니다. 예를 들어 코드 조각이 작동하는 이유를 기록하고 싶을 수 있습니다. 이를 위해 주석을 사용합니다.

 

일반적으로 주석을 사용하여 수식, 알고리즘 및 복잡한 비즈니스 논리를 설명합니다.

 

프로그램을 실행할 때 Python 인터프리터는 주석을 무시하고 코드만 해석합니다.

 

Python은 블록 주석, 인라인 주석 및 문서 문자열을 포함하여 세 가지 종류의 주석을 제공합니다.

 

 

2. Python block comments

블록 주석은 뒤에 오는 코드를 설명한다. 일반적으로 코드 블록과 동일한 수준에서 블록 주석을 들여씁니다.

블록 주석을 작성하려면 단일 해시 기호(#)로 시작한 다음 공백과 텍스트 문자열을 입력합니다. 예:

 

# increase price by 5%
price = price * 1.05

 

3. Python inline comments: 인라인 주석

문과 같은 줄에 주석을 달면 인라인 주석이 표시됩니다.

블록 댓글과 마찬가지로 인라인 댓글(#)과 텍스트 문자열에 의해 시작되며 텍스트 문자열에 의해 다음 공간 및 텍스트 문자열에 의해 이어졌다.

 

다음 예제에서는 인라인 주석을 보여 줍니다:

salary = salary * 1.02   # increase salary by 2%

 

4. Python docstrings: 파이썬 문서 문자열

문서 문자열은 코드 블록의 첫 번째 줄(예: 함수)로 넣는 문자열 리터럴입니다.

일반적인 주석과 달리 obj를 사용하여 런타임에 문서 문자열에 액세스할 수 있습니다.__doc__ 특성 여기서 obj는 함수의 이름입니다.

일반적으로 문서 문자열을 사용하여 코드 문서를 자동으로 생성합니다.

문서 문자열이라고 불립니다.

 

기술적으로 말해서, 문서들은 댓글이 아니다.문자열을 참조하는 익명 변수를 만듭니다.또한 파이썬 통역사가 무시되지 않습니다.

파이썬은 두 종류의 문서 문자열, 즉 한 줄 문서 문자열과 여러 줄 문서 문자열을 제공한다.

 

1) One-line docstrings

이름에서 알 수 있듯이 한 줄 문서 문자열은 한 줄에 맞습니다. 한 줄 문서 문자열은 세 개의 따옴표("")로 시작하고 세 개의 따옴표("")로 끝납니다. 또한 한 줄 문서 문자열 앞이나 뒤에 빈 줄이 없습니다.

다음 예제에서는 quicksort() 함수의 한 줄 문서 문자열을 보여 줍니다:

def quicksort():
""" sort the list using quicksort algorithm """
...

 

2) Multi-line docstrings

한 줄 문서 문자열과 달리 여러 줄 문서 문자열은 여러 줄에 걸쳐 있을 수 있습니다. 다중 행 문서 문자열은 또한 세 개의 따옴표("")로 시작하고 세 개의 따옴표("")로 끝납니다.

 

다음 예제에서는 다중 줄 문서 문자열을 사용하는 방법을 보여 줍니다:

def increase(salary, percentage, rating):
    """ increase salary base on rating and percentage
    rating 1 - 2 no increase
    rating 3 - 4 increase 5%
    rating 4 - 6 increase 10%
    """

 

5. Python multiline comments

Python은 여러 줄의 주석을 지원하지 않습니다.

그러나 다중 행 문서 문자열( multi-line docstrings) 을 다중 행 주석으로 사용할 수 있습니다. 파이썬을 만든 귀도 반 로섬도 이를 추천했다.

여러분의 의견을 명확하고 간결하며 설명적으로 유지하는 것이 좋은 관행입니다. 궁극적인 목표는 당신과 나중에 코드를 작업할 다른 개발자들을 위해 시간과 에너지를 절약하는 것이다.

 

 

6. Summary

• 필요할 때 주석을 사용하여 코드를 문서화합니다.
• 블록 주석 및 인라인 주석은 해시 기호(#)로 시작합니다.
• 함수, 모듈 및 클래스에 문서 문자열을 사용합니다.
     

 

 

 

 

refrence: https://www.pythontutorial.net/python-basics/python-comments/