ツイストのドキュメントストリングでのこれらのフォーマットの意味は何ですか？

Question

twistedのソースコードでは、多くのドキュメントストリングに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プロデューサー？

ところで、これらの形式は、標準的なpythonのdocstring形式の一部ですか？もしそうなら、私はどこを参照すべきですか？ありがとう:)

Answer 1

Twistedで使用されるドキュメント形式はEpytext, which is documented on epydoc.sourceforge.netです。

L{}は、「コード」（すなわちhello C{foo} bar「はハローfooバー」のようにフォーマットされるべきである）（「これはPythonの識別子であり、それにリンクしてください」すなわち）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であり、そこを閲覧することができます。