2012-03-23 5 views
1

저는 C++, perl 또는 C#과 같이 멋지고 강력한 언어라고 생각하기 때문에 파이썬을 배우고 있습니다. 그러나 동시에 정말 쉽습니다. 나는 JetBrains의 'Pycharm을 사용하고 있는데 제가 함수를 정의 할 때 내가 예는이 같은 추가를 클릭 할 때 "문서 문자열 스텁"을 추가달라고 :문서 String Stub, Python

""" 

""" 

그래서 함수의 전체 코드가 뭔가를 like :

def otherFunction(h, w): 
    """ 

    """ 
    hello = h 
    world = w 
    full_word = h + ' ' + w 

    return full_word 

나는 ("" "" ") 기호가 무엇을 의미하는지 알고 싶습니다. 감사합니다.

답변

6

"" "" ""는 파이썬에서 여러 줄에 걸쳐있는 문자열의 이스케이프 시퀀스입니다.

그들은 문서를 제공하는 함수 나 클래스 선언 직후에 넣어

에 대한 말했다 기능/클래스

+0

그래서 docstring은 함수에 대한 주석과 같으며 함수가 수행하는 작업을 말합니다. oO –

+0

정확하게 입력하면 bkconrad가 더 자세한 정보를 위해 게시됨에 따라 [wikipedia article] (http://en.wikipedia.org/wiki/Docstring#Python)을 참조하십시오. –

+1

@AndresOrozco :'help (nameOfYourFunction) '인터프리터 인터프리터에서는 함수 이름과 정의 아래에 삼중 따옴표로 배치 한 내용을 인쇄합니다. 또한 파이썬의 모든 내장 함수에 대해 이렇게 할 것이며, docstrings도 활용할 것이다. –

1

이들을 'docstrings'이라고하며 파이썬에 대한 인라인 문서를 제공합니다. The PEP에는 일반적으로 설명되어 있으며 wikipedia article에는 몇 가지 예가 나와 있습니다.

+1

실제로 트리플 인용 문자열은 여러 줄 문자열 리터럴입니다. Docstring은 문자열 리터럴 일 수 있으며 코드 블록의 첫 번째 항목 일뿐입니다. –

2

삼중 따옴표 여러 줄 문자열을 나타냅니다 (그들은 문서화 문자열라고하고 있습니다). 함수를 설명하기 위해 텍스트를 그 안에 넣을 수 있습니다. 프로그램 자체에서 액세스 할 수도 있습니다.

def thirdFunction(): 
    """ 
    All it does is printing its own docstring. 
    Really. 
    """ 
    print(thirdFunction.__doc__) 
+0

아, 함수의 설명과 비슷하지만 주석과 같습니다. 그래서 프로그램이 실행 중일 때 그것을 볼 수 없습니까? –

+1

당신은'__doc__' 속성을 사용할 수 있습니다. 따옴표 안에 텍스트를 넣고 실행 된 코드에'print' 문을 추가하십시오. 추신 파이썬 3을 사용하고 있다면 구문은'print (otherFunction .__ doc __)'이 될 것입니다. –

+0

글쎄,이 http://i.imgur.com/VUfKF.png 같은 somethin 있지만 "AtributeError : 'str'개체에 '_doc_'특성이 없습니다" –

관련 문제