이 파이썬 코드에서 docstring을 사용하는 것은 무엇입니까?

Question

간단한 전자 메일 python 스크립트에서 docstrings에 대한 질문이 있습니다.

message = """\ 
From: %s 
To: %s 
Subject: %s 

%s 
""" % (FROM, ", ".join(TO), SUBJECT, TEXT) 

나는 이메일 스크립트에서 종종이 같은 문서화 문자열을 참조하십시오. 내 질문은, docstring 뭐하는거야? 나는 문지름이 help 명령에만 사용되었다고 생각했습니다. 이것이 어리석은 질문이라면 사과드립니다.

감사합니다. 그것은 여러 줄의 문자열을 작성하는 유용하기 때문에

Answer 1

IT는 docs에서의 :

문자열 리터럴는 여러 줄이 될 수 있습니다. 한 가지 방법은 삼중 따옴표 "" "..." ""또는 '' '...' ''을 사용하는 것입니다.

Answer 2

"""...""" (삼중 따옴표)이있는 문자열을 여러 줄 문자열이라고합니다. 여러 줄 문자열과 docstring은 구분됩니다. 후자는 전자의 하위 집합입니다.

해당 변수가 변수에 할당되었으므로 이 아니고 docstring입니다. 문서화 문자열은 다음과 같이 함수의 맨 위에 찾을 것 무엇 :

def foo(): 
    """This is a doc-string""" 
    pass 

을 그리고 foo.__doc__을 인쇄하는 당신에게

print(foo.__doc__) 
'This is a doc-string' 

당신은 이해해야을 제공하는 기능의 첫 번째 여러 줄 문자열이 (할당 해제 된 경우)는 함수의 문서화 문자열이되고 (최적화 스위치가 설정되지 않은 경우) 나머지는 모두 삭제됩니다. 이에

,

message = """\ 
From: %s 
To: %s 
Subject: %s 

%s 
""" % (FROM, ", ".join(TO), SUBJECT, TEXT) 

변수 message에 할당 된 일부 C 스타일 형식 인수 여러 줄 문자열로 일어난다.

추가 읽기 :

• PEP 257

• What is the standard Python docstring format? 문서화 문자열하지만 그냥 일반 문자열 (str)하지

Answer 3

. 삼중 겹 따옴표 (""") 또는 삼중 따옴표 (''')를 사용하면 파이썬에게 긴 문자열로 사용하도록 알려줍니다. 이 문자열은 \n으로 구분됩니다. Docstring은이 종류의 긴 문자열을 사용하여 읽기 쉽게합니다. 이

이 말이 희망 등, 제목, 텍스트, CC를 지정하는 변수를 사용하여 이메일을 준비하고 같이 당신의 코드에서

는 것 같다.