Python: Was ist ein Header?

Ich bin neu in Python und Programmierung im Allgemeinen. Ich nehme ein Modul an der Universität, das erfordert, dass ich einige ziemlich grundlegende Programme in Python schreibe. Allerdings habe ich dieses Feedback auf meine letzte Aufgabe:Python: Was ist ein Header?

Es sollte ein Header-Block enthält den Dateinamen, den Namen des Autors, das Erstellungsdatum, Änderungsdatum und Python-Version

sein Was ist ein Header-Block ist ? Sind es nur Kommentare an der Spitze Ihres Codes oder ist es etwas, das beim Ausführen des Programms gedruckt wird? Oder etwas anderes?

Quelle

2013-04-25 Victoria Mackie

möglich Duplikat von [Python: Was ist das gemeinsame Header-Format?] (Http://StackOverflow.com/questions/1523427/python-what-is-the-common-header-format) – Vyktor

@Vyktor Nein. Es kann nützlich sein, OP, aber es ist ein anderes Thema. – delnan

In diesem Zusammenhang sind Sie richtig. Ein Headerblock bedeutet eine Reihe von Kommentaren am Anfang der Quelldatei, die die angeforderten Informationen enthält. Es muss keinen Code enthalten, der irgendetwas bewirkt.

Quelle

2013-04-25 17:20:26 recursive

Ihr Lehrer möchte, dass Sie einige Informationen zu Ihrer Zuordnung der Quellcode etwas Oberteil hinzuzufügen wie diese, so dass Sie Recht werden Sie Kommentare hinzufügen:

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

Quelle

2013-04-25 17:24:18

Warum nicht Zoidberg? Ich meine ... [Docstring] (http://www.python.org/dev/peps/pep-0257/). – Vyktor

Ich denke, es ist eine grundlegende Einführung Programmieraufgabe, daher hinzufügen üblichen Kommentare wird ausreichen, aber auf jeden Fall sollte sie Docstring wissen. –

Ein Kopfblock sind nur Kommentare an der Spitze der Code. Es wird nicht gedruckt, wenn das Programm ausgeführt wird.

könnte ein Beispiel wie folgt aussehen:

# 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

Quelle

2013-04-25 17:27:32 ustroetz

Es ist Sache Docstring in python genannt (und einige Konventionen über here're wie Python-Code im Allgemeinen schreiben - PEP 8) entweder durch dreifache Apostroph ''' oder dreifach entkommen Doppel Zitat """ gut geeignet für mehrzeilige Kommentare:

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

auch 210

Sie später spezielle Variablen verwendet werden (wenn ein Modul Programmierung), die enthalten Informationen wie gewidmet sind:

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

Weitere Details in answer here.

Quelle

2013-04-25 17:36:04 Vyktor

Sehr gute Diskussion hier ->What is the common header format of Python files?

Der Python docstring sollte prägnant sein, und nicht wirklich Revisionsgeschichte enthalten, oder irgendetwas nicht direkt auf die aktuelle Version Verhalten bezogen. Ich muss noch "Mann" Stil Docstrings sehen, und es kann genauso gut sein.

Ein Blumenkasten mit Revisionsverlauf unabhängig von der Quellcodeverwaltung (wie einige der Änderungen kann pre-date Quellcodeverwaltung schließlich) zu den Tagen geht zurück Code auf Papier zu lesen oder als per E-Mail. Wir waren nicht immer so verbunden wie jetzt.

Mit einem modernen IDE ist dies in Ungnade gefallen, aber kann für ältere/größere hochrangige Arbeiten gesehen werden. In einigen Geschäften wird die Anmeldung nicht vom Programmierer durchgeführt, insbesondere wenn der Code "ausgekauft" wurde. Einige Signins werden auf faule, schlampige Weise kommentiert.

So variiert, aber:

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

import foo 
import bar 

__metastuff__='some value'

ich die 'meta' höher, insbesondere in den youtube promotionals für "PyCharm" zu sehen. Leute mögen es unter den Importen sehen, da es wirklich Code ist und die Importe vor dem Code erwartet werden. Ich kann mir vorstellen, dass es leicht werden kann, sich davon zu befreien. Sinnvolle und informative Kommentare im Low-Level-Code sind viel mehr wert als das, was sowieso oben geschrieben wird.

In der realen Welt tun Sie einfach, was alle anderen an Ihrem Projekt tun, und es wird Ihnen gut gehen. Es ist üblich, eine Vorlage trotzdem zu verwenden oder Kopieren und Einfügen (d. H. Abzocken) von einem "Prototyp".

Quelle

2014-12-13 19:44:33 mckenzm

Python: Was ist ein Header?

Antwort

Verwandte Themen