왜곡 된 문서 문자열에서 이러한 형식의 의미는 무엇입니까?

Question

twisted 소스 코드에서 많은 docstring은 L {xxx} 또는 C {xxx}와 같은 형식을 포함하거나 '@'으로 시작하는 줄은 무엇입니까? 예를 들어

, 트위스트/인터넷/interfaces.py에서 :

def registerProducer(producer, streaming): 
    """ 
    Register to receive data from a producer. 
    ... 
    For L{IPullProducer} providers, C{resumeProducing} will be called once 
    each time data is required. 
    ... 
    @type producer: L{IProducer} provider 
    ... 
    @return: C{None} 
    """ 

L {IPullProducer} C {resumeProducing}, @type 생산?

그런데이 형식들은 표준 파이썬 문서 형식의 일부입니까? 그렇다면 어디서 참조해야합니까? 고마워요 :)

Answer 1

Twisted에서 사용되는 문서 형식은 Epytext, which is documented on epydoc.sourceforge.net입니다.

L{} (즉 hello C{foo} bar "는 헬로 foo 바"와 같은 형식으로한다) "코드"C{} 수단 ("이것은 그것에 연결하세요 파이썬 식별자"즉,) "링크"를 의미한다. I{}은 "기울임 꼴"을 의미합니다. epytext 문서에서 더 많은 필드를 볼 수 있습니다.

Twisted 프로젝트는 pydoctor --add-package twisted과 같은 호출을 사용하여 pydoctor의 설명서를 생성합니다. Twisted가 의존하는 몇 가지 다른 프로젝트에 대한 링크를 생성하는 데는 조금 더 많은 것이 있지만, 문서화 문자열을 Twisted에 기여하려는 경우이를 사용하여 아이디어를 얻을 수 있습니다. epydoc twisted을 사용하여 epydoc 자체로 문서를 생성 할 수도 있지만 epydoc은 Zope Interface에 대해 알지 못하므로 클래스를 구현하는 인터페이스에 클래스를 자동으로 연결하지 않습니다.

The generated API documentation for each release is published on twistedmatrix.com 그리고 거기에서 찾아 볼 수 있습니다.