Best practices: SQL-Repositories

Nachdem ich mich nun schon zum x-ten Mal durch Logfiles wühle, mal eine kleine Anregung: Werden die SQL-Statements einer Anwendung zentral in einer Datei gehalten (SQL-Repository/Statement-Repository), lohnt es sich, zu jedem Statement einen SQL-Kommentar aufzunehmen: Was macht das Statement und aus welchem Kontext wird es aufgerufen? Diese Kommentare werden typischerweise im Log gezeigt und vereinfachen die Analyse enorm. Gleichzeitig sinkt die Fehlerwahrscheinlichkeit bei Korrekturen durch allgemeines Verständnis. Was für das Anwendungsprogramm gilt, muss auch für Statements gelten: DOKU OR DIE!

Bei Statements empfiehlt sich die Kommentierung mit “/*” und “*/”, da der gebräuchlichere Einzellenkommentar mit “- -” ein blockweises Auskommentieren in XML-Dateien verhindert.