9

twisted のソースコードでは、多くの docstring に次のような形式が含まれています: L{xxx} や C{xxx}、または '@' で始まる行、それらの意味は何ですか?

たとえば、twisted/internet/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 フォーマットの一部ですか? その場合、どこを参照すればよいですか？ありがとう ：）

4

1 に答える 1

12

Twisted で使用されるドキュメント形式はEpytext で、ドキュメントは に記載されていepydoc.sourceforge.netます。

L{}「リンク」を意味します (つまり、「これは Python 識別子です。リンクしてください」)C{}は「コード」を意味します (つまり、「hello bar」 hello C{foo} barのようにフォーマットする必要があります)。単に「イタリック体で」を意味します。epytext ドキュメントでさらに多くのフィールドを確認できます。fooI{}

Twisted プロジェクトは、のような呼び出しを使用してpydoctorpydoctor --add-package twistedでドキュメントを生成します。Twisted が依存している他のいくつかのプロジェクトへのリンクを生成するために、もう少し作業がありますが、それを使用して Twisted にドキュメントストリングを提供したい場合にアイデアを得ることができます。を使用して、epydoc 自体でドキュメントを生成することもできますがepydoc twisted、epydoc は Zope インターフェイスについて認識しないため、実装するインターフェイスにクラスを自動的にリンクしません。

リリースごとに生成された API ドキュメントは twistedmatrix.comで公開されており、そこで参照できます。

于 2012-06-17T08:09:09.480 に答える