2012-10-14 2 views
4

edX.org의 온라인 CS188.1x 클래스 (강사가 작성한 코드)에서 사용 된 일부 코드를 검토하면서 주석으로 사용하기 위해 한 세트의 큰 따옴표를 반복적으로 사용하는 것으로 나타났습니다.Python 주석에 대한 큰 따옴표 집합?

나는 이것을 전에 보지 못했고, 찾을 수있는 PEP8에도 언급되어 있지 않지만 확실히 작동하는 것으로 보인다. 누구나 나를 계몽시킬 수 있습니까?

class SomeClass(): 
    """ 
    Some docstring info, using standard 'triple double quotes' 
    """ 
    def __init__(self): 
     "This is the comment style to which I'm referring." 
     some.code = foo  # Here's a normal inline comment 

    def bar(self, item): 
     "Here is another example of the comment style" 
     return wtf 

답변

4

docstring 클래스, 메소드, 함수 또는 모듈에 제 문 문자로 표시 문자열은 :

여기 일례이다. 스타일 상으로는 더 길고, 더 형식화 된 문서 문자열을 허용하고, 쉽게 참조 할 수 있도록주의를 환기시키기 위해 삼중 따옴표 형식을 사용하는 것이 일반적이지만 원하는 문자열이 적합합니다.

주석은 프로그램의 실행과 관련이 없으므로 주석과 구별되며, docstring은 런타임에 객체의 __doc__ 변수에 액세스하여 사용할 수 있습니다.

0

그건 단지 문서 문자열입니다. 좋은 디자인 추천입니다. 예를 들어 파이썬 셸에서 클래스를로드하면 help(bar)을 호출하면 "Here is another example of the comment style"

이 표시됩니다.