Hallo!
Wie kann ich Kommentare über mehrere Zeilen machen?
Grüße, pktm
Mehrzeilenkommentare
- gerold
- Python-Forum Veteran
- Beiträge: 5555
- Registriert: Samstag 28. Februar 2004, 22:04
- Wohnort: Oberhofen im Inntal (Tirol)
- Kontaktdaten:
Hallo pktm!pktm hat geschrieben:Wie kann ich Kommentare über mehrere Zeilen machen?
Willkommen im Python-Forum!
Jede Kommentarzeile muss mit einem "#" beginnen.
mfg
Gerold
http://halvar.at | Kleiner Bascom AVR Kurs
Wissen hat eine wunderbare Eigenschaft: Es verdoppelt sich, wenn man es teilt.
Wissen hat eine wunderbare Eigenschaft: Es verdoppelt sich, wenn man es teilt.
Code: Alles auswählen
#Das
#ist
#ein
#Kommentar
#ueber
#mehrere
#Zeilen
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
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.
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?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.
- Sr4l
- User
- Beiträge: 1091
- Registriert: Donnerstag 28. Dezember 2006, 20:02
- Wohnort: Kassel
- Kontaktdaten:
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
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:
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).
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)
Zu Docstrings und deren Formatierung siehe den Styleguide (PEP 8) sowie die Docstring Conventions (PEP 257).
-
- User
- Beiträge: 42
- Registriert: Sonntag 29. September 2019, 12:36
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!