Python：ヘッダとは何ですか？

Question

私は一般的にPythonとプログラミングに慣れていません。私は大学でモジュールを取っているので、かなり基本的なプログラムをPythonで書く必要があります。ヘッダブロックは何作成日、変更日およびPythonのバージョン

、著者名、ファイル名を含むヘッダブロックがあるはず

：しかし、私は私の最後の割り当てにこのフィードバックを得ました？それはあなたのコードの一番上のコメントか、それともプログラムが実行されたときにプリントするものなのでしょうか？または、他の何か？

Answer 1

この文脈では、あなたは正しいです。ヘッダーブロックは、要求された情報を含むソースファイルの一番上のコメントのセットを意味します。何もしないコードを含む必要はありません。

Answer 2

あなたのインストラクターが、あなたがこのようなあなたの割り当てのソースコードのトップセクションの何かにいくつかの情報を追加したい、あなたが正しいですので、あなたは、コメントを追加します。

#################################### 
# File name: ...     # 
# Author: ...      # 
# Submission:      # 
# Instructor:      # 
#################################### 

Answer 3

ヘッダブロックだけの上部にコメントしていますコード。プログラムの実行時には印刷されません。

例は次のようになります。

# File name: test.py 
# Author: Peter Test 
# Date created: 4/20/2013 
# Date last modified: 4/25/2013 
# Python Version: 2.7 

# Begin code 

a = 1 
b = 2 

c = a + b 

print c 

Answer 4

Docstring in pythonと呼ばれる事があります（とでPythonのコードを記述する方法についていくつかの規則をhere're一般 - PEP 8）トリプル単一引用符'''、トリプルのいずれかでエスケープ

''' 
    File name: test.py 
    Author: Peter Test 
    Date created: 4/20/2013 
    Date last modified: 4/25/2013 
    Python Version: 2.7 
''' 

： 複数行のコメントに適し二重引用符 """ answer hereで

__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" 

詳細：（モジュールのプログラミング時）210

あなたはまた、情報が含まれているために専用されていること、後に特別な変数を使用します。

Answer 5

ここに非常に良い議論 - >What is the common header format of Python files?

ザ・Pythonのドキュメント文字列は簡潔で、本当にリビジョン履歴、または現在のバージョンの動作に直接関係ないものを含むべきではありません。私は "man"スタイルのドキュメントストリングをまだ見ていないし、まあまあかもしれない。

ソースコントロールとは無関係の改訂履歴があります（前回のソースコントロールがある可能性があります）ので、コードを電子メールで読んでいる日に戻します。私たちは今のところいつもつながっているわけではありませんでした。

これは現代的なIDEを使用していますが、これは優先されていませんが、古いものから大きなものまで見ることができます。いくつかのショップでは、特にコードが「買い物に出された」場合、符号器によってサインインは実行されません。いくつかの署名は、怠け者で、控えめなやり方でコメントされています。

だから異なりますが、：

#! /usr/bin/python 
#--------------------------------# 
# optional flower box 
#--------------------------------# 
""" 
Multiple lines of doc if required 
""" 

import foo 
import bar 

__metastuff__='some value' 

私は "pycharm" のための、特にユーチューブのpromotionalsの 'メタ' 高いアップを参照してください。人々はそれが本当にコードであり、輸入がコードの前に来ると予想されるので、輸入の下でそれを見るのが好きです。私はそれが奪われやすくなるかもしれないと想像することができます。とにかく上の階層に書かれているものよりも、低レベルのコードの有益で有益なコメントは価値があります。

実際には、他の人があなたのプロジェクトでやっていることをやってください。あなたは大丈夫です。とにかくテンプレートを再利用すること、または「プロトタイプ」からコピー＆ペースト（すなわちripoff）することは一般的である。