Kommentar (Programmierung): Unterschied zwischen den Versionen
Sn (Diskussion | Beiträge) Keine Bearbeitungszusammenfassung |
Sn (Diskussion | Beiträge) Keine Bearbeitungszusammenfassung |
||
| Zeile 44: | Zeile 44: | ||
|} | |} | ||
== | == Sinnvoller Einsatz == | ||
Grundsätzlich gilt: Ein gut geschriebenes Programm braucht keine Kommentare, weil allein aus den Namen von [[Variable (Informatik)|Variable]]n, [[Unterprogramm#Funktionen|Funktionen]] und [[Klasse (Informatik)|Klasse]]n genau hervorgeht, was das Programm tut. | |||
{{Beispiel|1= | |||
Diese Funktion braucht beim besten Willen keinem Kommentar: | |||
<syntaxhighlight lang="python" line> | |||
def addiere(summand1, summand2): | |||
return summand1 + summand | |||
</syntaxhighlight> | |||
Ihre Aufgabe ist so banal wie offensichtlich. | |||
}} | |||
Mitunter gibt es Dinge, die sich nicht so selbsterklärend aufschreiben lassen. | |||
{{Todo|Sn}} | {{Todo|Sn}} | ||
Version vom 26. Januar 2025, 17:43 Uhr
Kommentare dienen beim Programmieren dazu, den Zweck von Programmteilen zu beschreiben und schwer lesbaren Code verständlicher zu machen.
Kommentare schreibt man nicht für den Computer, damit der das Programm verarbeiten kann.
Kommentare schreibt man für sich selbst und alle anderen Menschen, die diesen Code jemals lesen und verstehen werden müssen.
Syntax
| Sprache | Syntax |
|---|---|
| HTML | <!-- Kommentar,
darf beliebig
lang sein -->
|
| Python | # Kommentar, einzeilig
# Längere Kommentare
# müssen in jeder Zeile
# mit # beginnen
|
| Java JavaScript |
//Einzeiliger Kommentar
|
/* Mehrzeiliger
Kommentar */
| |
| CSS |
Sinnvoller Einsatz
Grundsätzlich gilt: Ein gut geschriebenes Programm braucht keine Kommentare, weil allein aus den Namen von Variablen, Funktionen und Klassen genau hervorgeht, was das Programm tut.
Diese Funktion braucht beim besten Willen keinem Kommentar:
def addiere(summand1, summand2):
return summand1 + summand
Ihre Aufgabe ist so banal wie offensichtlich.
Mitunter gibt es Dinge, die sich nicht so selbsterklärend aufschreiben lassen.
Dieser Abschnitt wird gerade von Sn überarbeitet
