Python コーディング ガイドラインに関するドキュメントで、Python ソース ファイルの次のヘッダー形式を見つけました。
#!/usr/bin/env python
"""Foobar.py: Description of what foobar does."""
__author__ = "Barack Obama"
__copyright__ = "Copyright 2009, Planet Earth"
これは Python の世界におけるヘッダーの標準形式ですか? ヘッダーには他にどのようなフィールドや情報を入れることができますか? Python の達人が、優れた Python ソース ヘッダーのガイドラインを共有しています :-)
ベストアンサー1
モジュールのすべてのメタデータですFoobar。
最初のものはdocstringモジュールのもので、これはすでに説明されているピーターの答え。
モジュール (ソース ファイル) を整理するにはどうすればよいですか? (アーカイブ)
各ファイルの最初の行は である必要があります
#!/usr/bin/env python。これにより、たとえば CGI コンテキストで、インタープリターを暗黙的に呼び出すスクリプトとしてファイルを実行することが可能になります。次は説明付きの docstring です。説明が長い場合は、最初の行は、それ自体で意味を成す短い要約にし、残りの部分と改行で区切る必要があります。
インポート ステートメントを含むすべてのコードは、docstring に従う必要があります。そうしないと、docstring はインタープリターによって認識されず、対話型セッション ( 経由など) や自動ツールでドキュメントを生成するときにアクセスできなくなります
obj.__doc__。最初に組み込みモジュールをインポートし、次にサードパーティのモジュール、パスの変更と独自のモジュールをインポートします。特に、パスへの追加とモジュールの名前は急速に変更される可能性があるため、1 か所にまとめておくと見つけやすくなります。
次は著者情報です。この情報は、次の形式に従う必要があります。
__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__ = "[email protected]" __status__ = "Production"ステータスは通常、「プロトタイプ」、「開発」、または「本番」のいずれかになります。は、
__maintainer__インポートされた場合にバグを修正し、改善を行う人である必要があります。は、バグ修正を報告したり、提案などを行ったりしたが、実際にコードを記述しなかった人を含む__credits__とは異なります。__author____credits__
ここ認識されたメタデータとして、、、、、、、および__author__をリストした、さらに詳しい情報があります。__authors____contact____copyright____license____deprecated____date____version__