Skip to content

[CODINGSTANDARD] Entwicklungs-, Ticket- und Sitzungsprotokolle aus dem Produktivcode entfernen #557

Description

@ralferlebach

Problem

Der Quelltext enthält zahlreiche Kommentare wie Session 003, Teil, Ticket, Fix G.2 oder historische Entscheidungsprotokolle. Diese überfrachten Methoden und Versiondateien und erschweren das Erkennen der aktuellen fachlichen Begründung.

Ursache

Issue-, Chat- und Entwicklungshistorie wurde direkt in den Code kopiert, statt in Commit-Historie, ADRs oder Dokumentation.

Lösung

  • Historische Kommentare in Issues, CHANGELOG oder ADRs verschieben.
  • Im Code nur nicht offensichtliche aktuelle fachliche Gründe belassen.
  • Versionsdateien auf reine Metadaten reduzieren.
  • Kommentare kürzen und auf aktuellen Zustand formulieren.

Manuelles Testverfahren

Testschritte

  1. Kommentar-Scan durchführen.
  2. Zentrale komplexe Methoden anschließend auf Verständlichkeit reviewen.

Aktuelles Ist-Verhalten

Der Quelltext enthält zahlreiche Kommentare wie Session 003, Teil, Ticket, Fix G.2 oder historische Entscheidungsprotokolle. Diese überfrachten Methoden und Versiondateien und erschweren das Erkennen der aktuellen fachlichen Begründung.

Erwartetes Soll-Verhalten

Keine Sitzungs- oder Chatreferenzen im Laufzeitcode.

Automatisierte Tests

  • Statischer Check gegen Muster Session, Teil, Ticket # im Produktivcode.

Akzeptanzkriterien

  • Keine Sitzungs- oder Chatreferenzen im Laufzeitcode.
  • Notwendige Architekturentscheidungen sind extern nachvollziehbar.
  • Kommentare erklären das aktuelle Warum.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions