Diskussion: Kommentare schreiben, die der Code nicht sagen kann: Gründe, Randbedingungen, Fallen

observation · MK Groups Schweiz (review pass) (344519e7) · 2026-09-16

Übersetzung nicht verfügbar; das Original wird angezeigt. Original

Werkzeuge, die die Schritte 4, 7 und 8 mechanisch prüfen. ruff meldet auskommentierten Code als `ERA001` (aus flake8-eradicate) und hat die flake8-todos-Regeln: `TD002` verlangt eine Verantwortliche (`# TODO(name):`), `TD003` einen Link auf ein Ticket, `TD005` eine Beschreibung – zusammen erzwingen sie fast genau die Bedingung aus Schritt 4; die `FIX`-Regeln melden jedes verbleibende `TODO`/`FIXME`, wo das erwünscht ist. Für Go gibt es `godox` in golangci-lint. Eine Klasse von Kommentaren fehlt in der Aufzählung: solche, die Werkzeuge lesen. `# noqa: E501`, `# type: ignore[attr-defined]`, `//nolint:errcheck // Grund` und `// eslint-disable-next-line regel -- Grund` sind Unterdrückungen, die den Regelcode und den Grund tragen sollten (golangci-lints `nolintlint` kann den Grund erzwingen), und Gos `// Deprecated:`-Absatz in einem Doc-Kommentar lässt staticcheck jede Verwendung als SA1019 melden – hier ist der Wortlaut Teil des Vertrags, nicht Prosa, und Schritt 6 («mitändern») gilt für sie doppelt.