Obwohl Kommentare in erster Linie f\u00fcr Entwickler<\/a> gedacht sind, kann das Schreiben von effektiven Kommentaren auch dabei helfen, eine hervorragende Dokumentation f\u00fcr die Benutzer deines Codes zu erstellen. Mit Hilfe von Dokumentgeneratoren wie Sphinx<\/a> f\u00fcr Python-Projekte k\u00f6nnen die Kommentare in deinem Code den Inhalt f\u00fcr deine Dokumentation liefern.<\/p>\n Werfen wir nun also einen Blick auf Kommentare in Python.<\/p>\n Laut dem Python PEP 8 Style Guide<\/a> gibt es beim Schreiben von Kommentaren einige Dinge zu beachten:<\/p>\n In Python wird eine Zeile als Kommentar deklariert, wenn sie mit dem Symbol Inline-Kommentare enthalten kurze Beschreibungen von Variablen und einfachen Operationen und werden in der gleichen Zeile wie die Code-Anweisung geschrieben:<\/p>\n Der Kommentar erkl\u00e4rt die Funktion des Codes in der gleichen Anweisung wie der Code.<\/p>\n Blockkommentare werden verwendet, um komplexe Logik im Code zu beschreiben. Blockkommentare in Python sind \u00e4hnlich aufgebaut wie Inline-Kommentare – der einzige Unterschied ist, dass Blockkommentare in einer eigenen Zeile geschrieben werden:<\/p>\n Der einzige Unterschied ist, dass Blockkommentare in einer separaten Zeile stehen: Wenn du Blockkommentare verwendest, stehen sie \u00fcber dem Code, den sie erkl\u00e4ren. Der Python PEP8 Style Guide schreibt vor, dass eine Codezeile nicht mehr als 79 Zeichen enthalten sollte, und Inline-Kommentare \u00fcberschreiten oft diese Zeilenl\u00e4nge. Aus diesem Grund werden Blockkommentare geschrieben, um den Code in separaten Zeilen zu beschreiben.<\/p>\n Python unterst\u00fctzt von Haus aus keine mehrzeiligen Kommentare, d.h. es gibt keine spezielle M\u00f6glichkeit, sie zu definieren. Trotzdem werden oft Kommentare verwendet, die sich \u00fcber mehrere Zeilen erstrecken.<\/p>\n Du kannst einen mehrzeiligen Kommentar aus mehreren einzeiligen Kommentaren erstellen, indem du jeder Zeile ein Du kannst auch die Syntax f\u00fcr mehrzeilige Strings verwenden. In Python kannst du mehrzeilige Strings definieren, indem du sie in Im obigen Code wird die mehrzeilige Zeichenkette keiner Variablen zugewiesen, wodurch die Zeichenkette wie ein Kommentar wirkt. Zur Laufzeit ignoriert Python die Zeichenkette, und sie wird nicht in den Bytecode aufgenommen. Wenn du den obigen Code ausf\u00fchrst, erh\u00e4ltst du die folgende Ausgabe:<\/p>\n Kommentare machen deinen Code nicht nur lesbar, sondern dienen in Python auch einigen besonderen Zwecken, z. B. der Planung zuk\u00fcnftiger Code-Erg\u00e4nzungen und der Erstellung von Dokumentation.<\/p>\n In Python sind Docstrings mehrzeilige Kommentare, die erkl\u00e4ren, wie man eine bestimmte Funktion oder Klasse verwendet. Die Dokumentation deines Codes wird durch die Erstellung von hochwertigen Docstrings verbessert. Wenn du mit einer Funktion oder Klasse arbeitest und die eingebaute Funktion Python PEP 257<\/a> bietet eine Standardmethode zur Deklaration von Docstrings in Python, die im Folgenden dargestellt wird:<\/p>\n Im obigen Code liefert der Docstring Details dar\u00fcber, wie die zugeh\u00f6rige Funktion funktioniert. Mit Dokumentationsgeneratoren wie Sphinx kann dieser Docstring verwendet werden, um den Benutzern deines Projekts einen \u00dcberblick \u00fcber die Verwendung dieser Methode zu geben.<\/p>\n Ein Docstring, der direkt unterhalb der Funktions- oder Klassensignatur definiert ist, kann auch mit der eingebauten Funktion Der Funktionsaufruf Das Attribut Beim Schreiben von Code kann es vorkommen, dass du bestimmte Zeilen oder ganze Bl\u00f6cke markieren m\u00f6chtest, um sie zu verbessern. Diese Aufgaben werden durch TODO-Kommentare gekennzeichnet. TODO-Kommentare sind praktisch, wenn du Aktualisierungen oder \u00c4nderungen an deinem Code planst oder wenn du die Benutzer oder Mitarbeiter des Projekts dar\u00fcber informieren m\u00f6chtest, dass bestimmte Abschnitte des Codes noch geschrieben werden m\u00fcssen.<\/p>\n TODO-Kommentare sollten nicht als Pseudocode geschrieben werden – sie m\u00fcssen nur kurz die Funktion des noch nicht geschriebenen Codes erkl\u00e4ren.<\/p>\n TODO-Kommentare und einzeilige Blockkommentare sind sich sehr \u00e4hnlich. Der einzige Unterschied zwischen ihnen ist, dass TODO-Kommentare mit einem TODO-Pr\u00e4fix beginnen m\u00fcssen:<\/p>\n Obwohl viele IDEs diese Kommentare f\u00fcr den Programmierer hervorheben k\u00f6nnen, werden TODO-Kommentare vom Python-Interpreter nicht anders behandelt als Blockkommentare.<\/p>\n Es gibt eine Reihe von Best Practices, die beim Schreiben von Kommentaren befolgt werden sollten, um Zuverl\u00e4ssigkeit und Qualit\u00e4t zu gew\u00e4hrleisten. Im Folgenden findest du einige Tipps f\u00fcr das Schreiben hochwertiger Kommentare in Python.<\/p>\n Kommentare, die das Offensichtliche aussprechen, bringen keinen Mehrwert f\u00fcr deinen Code und sollten vermieden werden. Zum Beispiel:<\/p>\n Dieser Kommentar ist nicht n\u00fctzlich, da er einfach nur angibt, was der Code macht, ohne zu erkl\u00e4ren, warum er gemacht werden muss. Kommentare sollten eher das „Warum“ als das „Was“ des Codes erkl\u00e4ren, den sie beschreiben.<\/p>\n Umgeschrieben k\u00f6nnte das obige Beispiel wie folgt aussehen:<\/p>\n Halte deine Kommentare kurz und leicht verst\u00e4ndlich. Sie sollten in normaler Prosa geschrieben sein, nicht in Pseudocode, und sie sollten die Notwendigkeit ersetzen, den eigentlichen Code zu lesen, um einen allgemeinen \u00dcberblick dar\u00fcber zu bekommen, was er tut. Zu viele Details oder komplexe Kommentare machen die Arbeit der Programmierer\/innen nicht einfacher. Ein Beispiel:<\/p>\n Der obige Kommentar enth\u00e4lt mehr Informationen, als f\u00fcr den Leser notwendig sind. Anstatt die Kernlogik zu beschreiben, sollten Kommentare eine allgemeine Zusammenfassung des Codes liefern. Dieser Kommentar kann umgeschrieben werden als:<\/p>\n Bezeichner sollten in Kommentaren sorgf\u00e4ltig verwendet werden. Das \u00c4ndern von Bezeichnernamen oder Gro\u00dfbuchstaben kann den Leser verwirren. Beispiel:<\/p>\n Im obigen Kommentar werden Wenn du Code schreibst, solltest du das DRY-Prinzip (don’t repeat yourself) einhalten und WET (write everything twice) vermeiden.<\/p>\n Das gilt auch f\u00fcr Kommentare. Vermeide es, mehrere Anweisungen zu verwenden, um deinen Code zu beschreiben, und versuche, Kommentare, die denselben Code erkl\u00e4ren, in einem einzigen Kommentar zusammenzufassen. Beim Zusammenf\u00fchren von Kommentaren musst du jedoch vorsichtig sein: Das unvorsichtige Zusammenf\u00fchren mehrerer Kommentare kann zu einem riesigen Kommentar f\u00fchren, der gegen die Stilrichtlinien verst\u00f6\u00dft und f\u00fcr den Leser schwer zu verstehen ist.<\/p>\n Denk daran, dass Kommentare die Lesezeit des Codes verk\u00fcrzen sollen.<\/p>\n Im obigen Code sind die Kommentare unn\u00f6tig aufgesplittert und k\u00f6nnen zu einem einzigen Kommentar zusammengef\u00fcgt werden:<\/p>\n Achte darauf, dass die Kommentare auf der gleichen Ebene einger\u00fcckt sind wie der Code, den sie beschreiben. Wenn das nicht der Fall ist, kann es schwierig werden, ihnen zu folgen.<\/p>\n Dieser Kommentar ist zum Beispiel nicht richtig einger\u00fcckt oder positioniert:<\/p>\n Er kann wie folgt umgeschrieben werden:<\/p>\n Kommentare sind ein wichtiger Bestandteil, um verst\u00e4ndlichen Code zu schreiben. Die Investition, die du beim Schreiben eines Kommentars hinein steckst, wird dein zuk\u00fcnftiges Ich – oder andere Entwickler, die an deinem Code arbeiten m\u00fcssen – zu sch\u00e4tzen wissen. Durch Kommentare erh\u00e4ltst du au\u00dferdem tiefere Einblicke in deinen Code.<\/p>\n In diesem Tutorium hast du mehr \u00fcber Kommentare in Python gelernt, einschlie\u00dflich der verschiedenen Arten von Python-Kommentaren, wann du sie verwenden solltest und wie du sie am besten anlegst.<\/p>\n Das Schreiben von guten Kommentaren ist eine F\u00e4higkeit, die du lernen und entwickeln musst. Um das Schreiben von Kommentaren zu \u00fcben, solltest du zu einigen deiner fr\u00fcheren Projekte zur\u00fcckgehen und Kommentare hinzuf\u00fcgen. Um dich zu inspirieren und die besten Praktiken in Aktion zu sehen, schau dir gut dokumentierte Python-Projekte auf GitHub an.<\/p>\n Wenn du bereit bist, deine eigenen Python-Projekte in Betrieb zu nehmen, kannst du deinen Code mit der Anwendungs Hosting-Plattform<\/a> von Kinsta in Sekundenschnelle von GitHub in die Cloud<\/a> bringen.<\/p>\n","protected":false},"excerpt":{"rendered":" Kommentare sind Notizen, die Programmierer an ihren Code anh\u00e4ngen, um zu erkl\u00e4ren, was der Code tun soll. Die Compiler oder Interpreter, die den Code in die …<\/p>\n","protected":false},"author":275,"featured_media":58134,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_kinsta_gated_content":false,"_kinsta_gated_content_redirect":"","footnotes":""},"tags":[],"topic":[974],"class_list":["post-57877","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","topic-python"],"yoast_head":"\nKommentare in Python<\/h2>\n
\n
#<\/code> beginnt. Wenn der Python-Interpreter in deinem Code auf #<\/code> st\u00f6\u00dft, ignoriert er alles, was nach diesem Symbol kommt, und gibt keinen Fehler aus. Es gibt zwei M\u00f6glichkeiten, einzeilige Kommentare zu deklarieren: Inline-Kommentare und Block-Kommentare.<\/p>\nInline-Kommentare<\/h3>\n
border = x + 10 # Make offset of 10px<\/code><\/pre>\nBlock-Kommentare<\/h3>\n
import csv\nfrom itertools import groupby\n\n# Get a list of names in a sequence from the csv file\nwith open('new-top-firstNames.csv') as f:\n file_csv = csv.reader(f)\n\n# Skip the header part: (sr, name, perc)\nheader = next(file_csv)\n \n# Only name from (number, name, perc)\npersons = [ x[1] for x in file_csv]\n\n# Sort the list by first letter because \n# The groupby function looks for sequential data.\npersons.sort(key=lambda x:x[0])\ndata = groupby(persons, key=lambda x:x[0])\n\n# Get every name as a list \ndata_grouped = {}\nfor k, v in data:\n # Get data in the form \n # {'A' : [\"Anthony\", \"Alex\"], \"B\" : [\"Benjamin\"]}\n data_grouped[k] = list(v)<\/code><\/pre>\nMehrzeilige Kommentare<\/h3>\n
#<\/code> voranstellst:<\/p>\n# interpreter \n# ignores\n# these lines<\/code><\/pre>\n\"\"\"<\/code>, dreifache doppelte Anf\u00fchrungszeichen, oder '''<\/code>, dreifache einfache Anf\u00fchrungszeichen einschlie\u00dft:<\/p>\nprint(\"Multi-Line Comment\")\n\"\"\"\nThis\nString is \nMulti line \n\"\"\"<\/code><\/pre>\nMulti-Line Comment<\/code><\/pre>\n\nBesondere Kommentare<\/h2>\n
Python Docstring-Kommentare<\/h3>\n
help(obj)<\/code> verwendest, k\u00f6nnen docstrings hilfreich sein, um einen \u00dcberblick \u00fcber das Objekt zu geben.<\/p>\nfrom collections import namedtuple\nPerson = namedtuple('Person', ['name', 'age'])\n\n def get_person(name, age, d=False):\n \"\"\"\nReturns a namedtuple(\"name\", \"age\") object.\nAlso returns dict('name', 'age') if arg `d` is True\n\nArguments:\nname \u2013 first name, must be string\nage \u2013 age of person, must be int\nd \u2013 to return Person as `dict` (default=False)\n\n\"\"\"\np = Person(name, age)\nif d:\n return p._asdict()\nreturn p<\/code><\/pre>\nhelp()<\/code> zur\u00fcckgegeben werden. Die Funktion help()<\/code> nimmt ein Objekt oder einen Funktionsnamen als Argument und gibt die Docstrings der Funktion als Ausgabe zur\u00fcck. Im obigen Beispiel kann help(get_person)<\/code> aufgerufen werden, um die mit der Funktion get_person<\/code> verkn\u00fcpften Docstrings anzuzeigen. Wenn du den obigen Code in einer interaktiven Shell mit dem Flag -i<\/code> ausf\u00fchrst, kannst du sehen, wie dieser Docstring von Python geparst wird. F\u00fchre den obigen Code aus, indem du python -i file.py<\/code> eingibst.<\/p>\n![\"Screenshot:](\"https:\/\/kinqsta.com\/wp-content\/uploads\/2022\/12\/parsing-python-docstrings-on-command-line.png\")
help(get_person)<\/code> gibt einen Docstring f\u00fcr deine Funktion zur\u00fcck. Die Ausgabe enth\u00e4lt get_person(name, age, d=False)<\/code>, das ist eine Funktionssignatur, die Python automatisch hinzuf\u00fcgt.<\/p>\nget_person.__ doc__<\/code> kann auch verwendet werden, um Docstrings programmatisch abzurufen und zu \u00e4ndern. Nach dem Hinzuf\u00fcgen von „Some more new information“ im obigen Beispiel erscheint es im zweiten Aufruf von help(get_person)<\/code>. Es ist jedoch unwahrscheinlich, dass du Docstrings zur Laufzeit dynamisch \u00e4ndern musst.<\/p>\nTODO-Kommentare<\/h3>\n
# TODO Get serialized data from the CSV file\n# TODO Perform calculations on the data\n# TODO Return to the user<\/code><\/pre>\nBest Practices beim Schreiben von Python-Kommentaren<\/h2>\n
Vermeide das Offensichtliche<\/h3>\n
x = x + 4 # increase x by 4<\/code><\/pre>\nx = x + 4 # increase the border width<\/code><\/pre>\nHalte die Python-Kommentare kurz und b\u00fcndig<\/h3>\n
# return area by performing, Area of cylinder = (2*PI*r*h) + (2*PI*r*r)\ndef get_area(r,h):\n return (2*3.14*r*h) + (2*3.14*r*r)<\/code><\/pre>\n# return area of cylinder\ndef get_area(r,h):\n return (2*3.14*r*h) + (2*3.14*r*r)<\/code><\/pre>\nBezeichner mit Bedacht verwenden<\/h3>\n
# return class() after modifying argument\ndef func(cls, arg):\n return cls(arg+5)\n<\/code><\/pre>\nclass<\/code> und argument<\/code> erw\u00e4hnt, die beide nicht im Code vorkommen. Dieser Kommentar kann umgeschrieben werden in:<\/p>\n# return cls() after modifying arg\ndef func(cls, arg):\n return cls(arg+5)<\/code><\/pre>\nDRY und WET<\/h3>\n
# function to do x work\ndef do_something(y):\n # x work cannot be done if y is greater than max_limit\n if y < 400:\n print('doing x work')\n<\/code><\/pre>\n# function to do x if arg:y is less than max_limit\ndef do_something(y):\n if y in range(400):\n if y in range(400):\n<\/code><\/pre>\nKonsistente Einr\u00fcckung<\/h3>\n
for i in range(2,20, 2):\n# only even numbers\n if verify(i):\n# i should be verified by verify()\n perform(x)<\/code><\/pre>\n# only even numbers\nfor i in range(2,20, 2):\n # i should be verified by verify()\n if verify(i):\n perform(x)<\/code><\/pre>\n\nZusammenfassung<\/h2>\n