파이썬 독스트링

코드의 일부를 이해하기 위해 파이썬 프로그램에서 코드에 주석을 달 수 있습니다. 그러나 주석과 주석의 다른 부분을 검색하려면 검색(CTL+F)을 사용해야 하며 많은 줄을 스크롤해야 합니다. 또한 우리는 주어진 단어가 코드의 얼마나 많은 섹션과 연관되어 있는지 알 수 있는 즉각적인 방법이 없습니다. 이 문제를 해결하기 위해 우리는 함수, 모듈, 클래스 또는 메서드 정의 직후 문자열에 액세스하는 python Docstring을 사용합니다.

독스트링 인쇄

__doc__ 속성은 파이썬 객체의 정의 직후에 선언될 때 파이썬 객체의 이름과 자동으로 연결됩니다. 그것을 명확히 하는 아래의 예.

예시

def Add_nums(x):
   '''Ada a number to itself.'''
   return x + x
print(Add_nums.__doc__)

출력

위의 코드를 실행하면 다음과 같은 결과가 나옵니다. -

Ada a number to itself.

한 줄 대 여러 줄 문서링

한 줄 독스트링은 한 줄로 되어 있으며 너무 설명적이어서는 안 됩니다. 그들은 문자열의 시작과 끝에서 삼중 따옴표로 묶여 있습니다. 위의 예는 한 줄의 독스트링입니다.

여러 줄 독스트링

때로는 모듈이나 기능을 더 자세히 설명해야 할 수도 있습니다. 이 경우 우리는 여러 줄 독스트링을 사용합니다. 한 줄의 독스트링과 같은 요약 줄을 표시한 다음 빈 줄을 표시하고 그 뒤에 더 자세한 설명을 표시합니다.

예시

def Fibonacci(n):
   '''The Fibonacci numbers are the numbers in the following integer sequence.
0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89, 144, .'''
   return x + x
print(Fibonacci.__doc__)

출력

위의 코드를 실행하면 다음과 같은 결과가 나옵니다. -

The Fibonacci numbers are the numbers in the following integer sequence.
0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89, 144, .

내장된 Python 객체의 독스트링

__doc__와 함께 클래스 이름을 사용하여 함수, 모듈 등과 같은 파이썬 객체와 관련된 문서에 쉽게 액세스할 수 있습니다.

예시

print(list.__doc__)

출력

위의 코드를 실행하면 다음과 같은 결과가 나옵니다. -

Built-in mutable sequence.

If no argument is given, the constructor creates a new empty list.
The argument must be an iterable if specified.

독스트링의 들여쓰기

독스트링의 첫 번째 줄(즉, 첫 번째 줄 바꿈까지)의 들여쓰기는 중요하지 않으며 제거됩니다. 독스트링에서 나중 줄의 상대적 들여쓰기는 유지됩니다. 전체 독스트링은 첫 번째 줄의 따옴표와 동일하게 들여쓰기됩니다.