Einführung
Kommentare sind Zeilen in Computerprogrammen, die von Compilern und Interpreten ignoriert werden. Durch das Einschließen von Kommentaren in Programme wird der Code für den Menschen besser lesbar, da Informationen oder Erklärungen zu den Aktionen der einzelnen Programmteile bereitgestellt werden.
Abhängig vom Zweck Ihres Programms können Kommentare als Notizen für Sie selbst oder als Erinnerung dienen, oder sie können mit der Absicht geschrieben werden, dass andere Programmierer verstehen, was Ihr Code tut.
Im Allgemeinen ist es eine gute Idee, Kommentare zu schreiben, während Sie ein Programm schreiben oder aktualisieren, da es leicht ist, Ihren Gedankenprozess später zu vergessen, und später geschriebene Kommentare können auf lange Sicht weniger nützlich sein.
Kommentare in Python beginnen mit einer Raute (#) und einem Leerzeichen und werden bis zum Ende der Zeile fortgesetzt.
Im Allgemeinen sehen Kommentare ungefähr so aus:
# This is a commentDa Kommentare nicht ausgeführt werden, wird beim Ausführen eines Programms dort kein Hinweis auf den Kommentar angezeigt. Kommentare sind im Quellcode für Menschen zum Lesen, nicht für Computer zum Ausführen.
In einem "Hallo Welt!" - Programm könnte ein Kommentar so aussehen:
hello.py
# Print “Hello, World!” to console
print("Hello, World!")sharks.py
# Define sharks variable as a list of strings
sharks = ['hammerhead', 'great white', 'dogfish', 'frilled', 'bullhead', 'requiem']
# For loop that iterates over sharks list and prints each string item
for shark in sharks:
print(shark)Kommentare sollten im selben Einzug wie der Code erfolgen, den sie kommentieren. Das heißt, einfunction definition ohne Einzug hätte einen Kommentar ohne Einzug, und jede folgende Einrückungsstufe hätte Kommentare, die mit dem Code übereinstimmen, den sie kommentiert.
Hier ist zum Beispiel, wie dieagain()-Funktion vonHow To Make a Simple Calculator Program in Python 3 tutorial kommentiert wird, wobei Kommentare auf jede Einrückungsstufe des Codes folgen:
calculator.py
...
# Define again() function to ask user if they want to use the calculator again
def again():
# Take input from user
calc_again = input('''
Do you want to calculate again?
Please type Y for YES or N for NO.
''')
# If user types Y, run the calculate() function
if calc_again == 'Y':
calculate()
# If user types N, say good-bye to the user and end the program
elif calc_again == 'N':
print('See you later.')
# If user types another key, run the function again
else:
again()Es werden Kommentare abgegeben, um Programmierern zu helfen, unabhängig davon, ob es sich um den ursprünglichen Programmierer oder eine andere Person handelt, die das Projekt verwendet oder daran mitarbeitet. Wenn Kommentare nicht ordnungsgemäß gepflegt und zusammen mit der Codebasis aktualisiert werden können, ist es besser, keinen Kommentar einzuschließen, als einen Kommentar zu verfassen, der dem Code widerspricht oder widerspricht.
Wenn Sie Code kommentieren, sollten Sie versuchen, diewhy hinter dem Code im Gegensatz zu denwhat oderhow zu beantworten. Wenn der Code nicht besonders knifflig ist, kann ein Blick auf den Code im Allgemeinen Aufschluss darüber geben, was der Code tut oder wie er es tut.
Blockkommentare können verwendet werden, um komplizierteren Code oder Code zu erklären, mit dem der Leser nicht vertraut sein dürfte. Diese längeren Kommentare gelten für einige oder den gesamten folgenden Code und werden auf derselben Ebene wie der Code eingerückt.
In Blockkommentaren beginnt jede Zeile mit der Raute und einem einzelnen Leerzeichen. Wenn Sie mehr als einen Absatz verwenden müssen, sollten diese durch eine Linie getrennt sein, die eine einzelne Raute enthält.
Hier ist ein Beispiel für einen Blockkommentar, der definiert, was in der unten definierten Funktionmain()geschieht:
# The main function will parse arguments via the parser variable. These
# arguments will be defined by the user on the console. This will pass
# the word argument the user wants to parse along with the filename the
# user wants to use, and also provide help text if the user does not
# correctly pass the arguments.
def main():
parser = argparse.ArgumentParser()
parser.add_argument(
"word",
help="the word to be searched for in the text file."
)
parser.add_argument(
"filename",
help="the path to the text file to be searched through"
)
...Blockkommentare werden in der Regel verwendet, wenn Vorgänge weniger einfach sind und daher eine gründliche Erläuterung erfordern. Sie sollten versuchen, eine Überkommentierung des Codes zu vermeiden, und anderen Programmierern das Verständnis von Python anvertrauen, es sei denn, Sie schreiben für eine bestimmte Zielgruppe.
Inline-Kommentare werden in derselben Zeile einer Anweisung nach dem Code selbst angezeigt. Wie andere Kommentare beginnen sie mit einem Rautezeichen und einem einzelnen Leerzeichen.
Inline-Kommentare sehen im Allgemeinen so aus:
[code] # Inline comment about the codeInline-Kommentare sollten sparsam verwendet werden, können jedoch zur Erklärung kniffliger oder nicht offensichtlicher Codeteile hilfreich sein. Sie können auch nützlich sein, wenn Sie der Meinung sind, dass Sie sich möglicherweise nicht mehr an eine Codezeile erinnern, die Sie in Zukunft schreiben, oder wenn Sie mit jemandem zusammenarbeiten, von dem Sie wissen, dass er nicht mit allen Aspekten des Codes vertraut ist.
Wenn Sie beispielsweise in Ihren Python-Programmen nicht vielemath verwenden, wissen Sie oder Ihre Mitarbeiter möglicherweise nicht, dass im Folgenden eine komplexe Zahl erstellt wird. Daher möchten Sie möglicherweise einen Inline-Kommentar dazu einfügen:
z = 2.5 + 3j # Create a complex numberInline-Kommentare können auch verwendet werden, um den Grund für eine Aktion oder einige zusätzliche Informationen zu erläutern, wie in:
x = 8 # Initialize x with an arbitrary numberKommentare, die in der Zeile gemacht werden, sollten nur verwendet werden, wenn dies erforderlich ist und wenn sie dem Leser des Programms hilfreiche Hinweise geben können.
Zusätzlich zur Verwendung von Kommentaren als Methode zum Dokumentieren von Code kann die Raute auch zum Auskommentieren von Code verwendet werden, den Sie nicht ausführen möchten, während Sie ein Programm testen oder debuggen, das Sie gerade erstellen. Das heißt, wenn nach dem Implementieren neuer Codezeilen Fehler auftreten, können Sie einige davon auskommentieren, um festzustellen, ob Sie das genaue Problem beheben können.
Mithilfe der Raute können Sie auch Alternativen ausprobieren, während Sie festlegen, wie der Code eingerichtet werden soll. Beispielsweise können Sie sich zwischen der Verwendung einerwhile loop- oder einerfor-Schleife in einem Python-Spiel entscheiden und die eine oder andere auskommentieren, während Sie testen und bestimmen, welche die beste ist:
guess.py
import random
number = random.randint(1, 25)
# number_of_guesses = 0
for i in range(5):
# while number_of_guesses < 5:
print('Guess a number between 1 and 25:')
guess = input()
guess = int(guess)
# number_of_guesses = number_of_guesses + 1
if guess < number:
print('Your guess is too low')
if guess > number:
print('Your guess is too high')
if guess == number:
break
if guess == number:
print('You guessed the number!')
else:
print('You did not guess the number. The number was ' + str(number))Durch das Auskommentieren von Code mit der Raute können Sie verschiedene Programmiermethoden ausprobieren und die Fehlerquelle ermitteln, indem Sie Teile eines Programms systematisch auskommentieren und ausführen.
Fazit
Durch die Verwendung von Kommentaren in Ihren Python-Programmen können Sie die Lesbarkeit Ihrer Programme für den Menschen verbessern, einschließlich Ihres zukünftigen Ichs. Das Einfügen geeigneter relevanter und nützlicher Kommentare kann es anderen erleichtern, bei Programmierprojekten mit Ihnen zusammenzuarbeiten, und den Wert Ihres Codes deutlicher machen.
Von hier aus möchten Sie möglicherweise mehr über PythonsDocstrings in PEP 257lesen, um mehr Ressourcen für die ordnungsgemäße Dokumentation Ihrer Python-Projekte bereitzustellen.