Kurallar kodlama: Python ile ilgili bir belge Python kaynak dosyaları için aşağıdaki üstbilgi biçimi rastladım

#!/usr/bin/env python

"""Foobar.py: Description of what foobar does."""

__author__      = "Barack Obama"
__copyright__   = "Copyright 2009, Planet Earth"

Bu Python dünyada başlıkları standart biçimi nedir? Diğer alanlar/bilgilerim başlığının içine ne olabilir? Uzmanları iyi Python kaynak başlıkları için kurallar payı Python :-)

Foobar Bu modül için tüm meta.

İlki zaten Peter's answer 'te açıklanan modülü docstring.

How do I organize my modules (source files)? (Archive)

Her dosyanın ilk satırı #!/usr/bin/env python olması gerekir.Bu mümkün bir komut yorumlayıcı dolaylı olarak, örneğin bir CGI bağlamda yürütmesini dosyayı çalıştırmak için yapar.

Sonraki bir açıklama ile Fibonacci sayıları olmalıdır.Eğer açıklama uzun ise, ilk satırı kendi içinde anlamlı kısa bir özeti olmalı, bir satır ile diğerlerinden ayrılmış.

Tüm kod, ithal ifadeleri de dahil olmak üzere, Fibonacci sayıları takip etmelidir.Aksi takdirde, Fibonacci sayıları tercüman tarafından tanınmaz ve otomatik araçlar ile belgeleri oluştururken interaktif oturumlarda erişimi (obj.__doc__ gibi) ya da olmaz.

İthalat-dahili modülleri birinci, üçüncü parti modüller, yolu ve kendi modülleri herhangi bir değişiklik tarafından izlenen.Özellikle, yol eklemeler ve modüllerin adları hızla değişim olasılığı: tek bir yerde onları tutmak onları bulmak için daha kolay hale getirir.

Bir sonraki yazarlık bilgi olmalıdır.Bu bilgi bu formatı takip etmelidir:

__author__ = "Rob Knight, Gavin Huttley, and Peter Maxwell"
__copyright__ = "Copyright 2007, The Cogent Project"
__credits__ = ["Rob Knight", "Peter Maxwell", "Gavin Huttley",
                    "Matthew Wakefield"]
__license__ = "GPL"
__version__ = "1.0.1"
__maintainer__ = "Rob Knight"
__email__ = "rob@spot.colorado.edu"
__status__ = "Production"

Durum genellikle bir "olmalıdır", "Gelişme" ya da "Üretim". Prototip __maintainer__ hataları düzeltmek ve ithal eğer iyileştirmeler yapacak olan kişi olmalıdır. __credits__ __credits__ hata düzeltmeleri, yapılan öneriler, vb bildirilen kişilere içeren __author__ farklıdır. ama aslında kod yazmak değil.

Here daha fazla bilgi Listeleme __author__, __authors__, __contact__, __copyright__, __license__, __deprecated__, __date__ ve __version__ olarak tanınan meta.