Bu formatların anlamı twisted's docstring?

Question

Twisted'ın kaynak kodunda, birçok docstrings aşağıdaki gibi biçimler içerir: L {xxx} veya C {xxx} veya bir satır bir '@' ile başlar, anlamları nedir? örneğin

, bükülmüş/internet/interfaces.py içinde:

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 üreticisi?

Bu arada, bu formatlar standart python docstring biçimlerinin bir parçası mı? Eğer öyleyse, nereye başvurmalıyım? Teşekkürler :)

Answer 1

Twisted tarafından kullanılan belge formatı Epytext, which is documented on epydoc.sourceforge.net'dur.

L{} (yani hello C{foo} bar "merhaba foo bar" biçiminde olmalıdır) "kod" C{} araçları ("bu, ona bağlantı lütfen bir Python tanımlayıcısı" yani) "bağlantı" anlamına gelmektedir. I{} sadece "italik" anlamına gelir. Epytext belgelerinde daha fazla alan görebilirsiniz.

Twisted projesi, pydoctor --add-package twisted gibi bir çağrı kullanarak belgelerini pydoctor ile üretir. Twisted'in güvendiği birkaç başka projeye bağlantı oluşturmak için biraz daha fazlası var, ama Twist'e docstring'e katkıda bulunmak istiyorsanız, bunu kullanmak için bunu kullanabilirsiniz. Ayrıca dokümanları epydoc twisted kullanarak epydoc'un kendisi ile üretebilirsiniz, ancak epydoc Zope Arabirimi hakkında bilgi sahibi olmaz ve böylece sınıfları otomatik olarak uyguladıkları arayüzlere bağlamaz.

The generated API documentation for each release is published on twistedmatrix.com, ve oraya göz atabilirsiniz.