Python içinde şimdi yaklaşık bir yıl için kodlama edilmiş ve sadece dosyanın üst kısmında bir değişken bildirir bir Theano tutorial bazı kod rastlamak:Python'da kullanılan "__docformat__" nedir?
__docformat__ = 'restructedtext en'
internet this PEP belgelerine üretti aranıyor. Yine de bu değişkeni ne zaman/neden belirtmek istediğinizi açık bir şekilde açıklamıyor.
Tüm Python kodumun en üstünde bildiriyor olmalıyım?
__docformat__ noktası piton belgelerine jeneratör araçları böyle epydoc olarak düzgün modül belgelerine (beklemek örneğin işaretleme dili) ayrıştırmak için nasıl bilmek olanak sağlamaktır. epydoc docs itibaren
:
bir modül için biçimlendirme dilini belirtmek için, modülün işaretleme dili adını içeren bir modül düzeyi dize değişkeni __docformat__ tanımlamalıdır. İşaretleme dilinin adı isteğe bağlı olarak bir dil koduyla izlenebilir (en ingilizce için gibi). Geleneksel olarak, __docformat__ değişkenin tanımı hemen modülün docstring'ini
Ancak, bu tür epydoc olarak birçok araç da komut satırı (örneğin epydoc --docformat restructuredtext) üzerinden biçimlendirme dilini belirterek desteklemek izliyorsa, bu bölümde yer alması sıkı ihtiyaç vardır docformat. Proje veya organizasyonunuz için kodlama kuralları ne olursa olsun.