Seite 1 von 1
Mehrzeilenkommentare
Verfasst: Sonntag 3. Juni 2007, 11:10
von pktm
Hallo!
Wie kann ich Kommentare über mehrere Zeilen machen?
Grüße, pktm
Re: Mehrzeilenkommentare
Verfasst: Sonntag 3. Juni 2007, 11:28
von gerold
pktm hat geschrieben:Wie kann ich Kommentare über mehrere Zeilen machen?
Hallo pktm!
Willkommen im Python-Forum!
Jede Kommentarzeile muss mit einem "#" beginnen.
mfg
Gerold
Verfasst: Sonntag 3. Juni 2007, 11:28
von EyDu
Mehrzeilige Kommentare werden nicht direkt durch Python unterstützt. Wenn du öfter solche Situationen hast, solltest du eventuell die entsprechenden Bereiche in eine Funktion/Methode auslagern, oder durch einen if schützen.
Mit den meisten IDEs ist es aber per Shortcut möglich, ganze bereiche aus und ein zu kommentieren
Verfasst: Sonntag 3. Juni 2007, 11:52
von BlackJack
Nicht nur IDEs, das sollte jeder vernünftige Texteditor können.
Verfasst: Sonntag 3. Juni 2007, 13:37
von Y0Gi
Es ist *möglich*, Multiline-Strings zu verwenden, ohne diese einem Namen zuzuordnen. Syntaktisch ist das korrekt.
Allerdings solltest du längere Ausführungen im Docstring der Funktion/Methode/Klasse unterbringen und in dessen Rumpf mit maximal zwei Zeilen pro Kommentar auskommen können.
Verfasst: Sonntag 3. Juni 2007, 15:05
von pktm
Y0Gi hat geschrieben:Es ist *möglich*, Multiline-Strings zu verwenden, ohne diese einem Namen zuzuordnen. Syntaktisch ist das korrekt.
Allerdings solltest du längere Ausführungen im Docstring der Funktion/Methode/Klasse unterbringen und in dessen Rumpf mit maximal zwei Zeilen pro Kommentar auskommen können.
Das hört sich nach etwas an was ich suche. Kannst du mir das näher ausführen?
Verfasst: Sonntag 3. Juni 2007, 15:06
von Sr4l
Code: Alles auswählen
def test():
"""in dieser funktion wird nur getestet
wie man diese kommentare schreibt sollte
aber in jedem guten tutorial stehen ;-)"""
return True
Verfasst: Sonntag 3. Juni 2007, 15:45
von rafael
Verfasst: Montag 4. Juni 2007, 12:52
von Y0Gi
Ja, schau dir mal den von rafael verlinken Thread an, dort habe u.a. auch ich etwas dazu geschrieben.
Letztlich sind Docstrings für Klassen, Methoden und Funktionen auch einfach Strings, die nicht explizit einen Namen zugewiesen bekommen. Durch ihre Position direkt unter der jeweiligen Signatur (class [...], def [...]) bekommen sie jedoch eine besondere Bedeutung und werden als Attribut zugreifbar. Dessen bedient sich auch nenen API-Doku-Generatoren die eingebaute Hilfe mit ``help(deine_funktion)``, die den Docstring ausgibt.
Beispiel:
Code: Alles auswählen
def do_something(a, b, c):
"""Do something with those arguments.
Additional information goes here.
"""
# Docstring ausgeben; ist nun ein Attribut
# der Funktion.
print do_something.__doc__
# Hilfe zu dieser Funktion aufrufen. Der Docstring wird
# aufbereitet und gemeinsam mit anderen Informationen
# ausgegeben, etwa über die Argumente der Funktion.
help(do_something)
Hinweis: Da der Docstring zum Rumpf dieser Funktion gehört, kann das ohne diesen erforderliche `pass` entfallen. Das gilt auch z.B. für eigene Exception-Klassen, die selbst mit einem einzeiligen Docstring insgesamt nur zwei Zeilen beanspruchen.
Zu Docstrings und deren Formatierung siehe den
Styleguide (PEP 8) sowie die
Docstring Conventions (PEP 257).
Re: Mehrzeilenkommentare
Verfasst: Montag 13. Juli 2020, 12:13
von christheturtle
Wirklich sicher gehst du nur mit der #-Methode. In den meisten Editoren gibt es außerdem ein Shortcut, um gleich mehrere Zeilen gleichzeitig auf diese Weise auszukommentieren. Ich habe dazu auch mal ein Video gemacht:
https://www.youtube.com/watch?v=t2VIdIhauvc, vielleicht hilft es dir weiter. Liebe Grüße!
Re: Mehrzeilenkommentare
Verfasst: Montag 13. Juli 2020, 17:34
von snafu
Bitte keine 13 Jahre alten Threads hervor kramen! Schon gar nicht wenn es bloß dem Bewerben des eigenen YouTube Kanals dienen soll...