Kommentare im Code

Kurz: Kommentare sind Text im Quellcode, den der Computer ignoriert. Sie erklären das Warum, nicht das Was.

Genauer: Guter Code erklärt sich weitgehend selbst durch klare Namen. Kommentare ergänzen, was man dem Code nicht ansieht: Gründe, Annahmen, Fallstricke, Verweise.

Im Detail

• Einzeilig: // (Java, C, JS, C#, Go), # (Python, Shell, YAML), -- (SQL, Lua).
• Mehrzeilig: /* … */ (C-Familie), """ … """ als Docstring in Python, <!-- … --> in HTML.
• Dokumentationskommentare: /** … */ (Javadoc), Docstrings (Python) erzeugen automatisch Dokumentation.
• Schlecht: i++; // erhöht i um 1 wiederholt nur den Code.
• Gut: // Timeout 30s, weil der Partner-Server langsam antwortet.
• TODO/FIXME: Marker für offene Arbeit, werden von Editoren hervorgehoben.
• Auskommentieren: Code vorübergehend abschalten, besser aber über Versionsverwaltung (git) löschen.

Siehe auch: README-Datei, Konstanten