Best Practices für eine gute Namenskonvention
Im Rahmen von Datenbankentwicklungsprojekten haben sich in den letzten Jahren Best Practices herausgebildet, zu denen auch die Erstellung und Einhaltung von Namenskonventionen gehört. Ziel dieser Best Practice ist es, die Entwicklung und Wartung von Datenbankapplikationen zu vereinfachen und am Ende Kosten einzusparen.
"Welche Vorteile hat eine gute Namenskonvention?"Namenskonventionen sind eine freiwillige Vereinbarung zwischen den Datenbankentwicklern und Programmierern. Sie geben vor wie beispielsweise Variablen, Objekte oder Konstanten zu definieren sind.
Eine gute Namenskonvention erleichtert die Festlegung von Objektbezeichnungen und Objektnamen in der Datenbank und schafft ein übergreifendes Verständnis zur Benennung von Sachverhalten, was besonders bei der Abstimmung von Anforderungen und Schnittstellen sehr wichtig ist.
Ein weiterer Pluspunkt ist, dass der Quelltext eines fremden Projekts sich schneller erschließen lässt. Der Datenbankentwickler muss sich nicht mehr auf den persönlichen Stil von verschiedenen anderen Datenbankentwicklern einstellen.
Gute Namenskonventionen bügeln Schwachstellen in der Datenbanksprache aus. Konventionen ermöglichen eine saubere Unterscheidung von Aufzählungstypen oder benannten Konstanten. Des Weiteren kann über eine saubere Namenskonvention leicht zwischen lokalen, klasseninternen und globalen Variablen unterschieden werden. Aber auch Tabellen, Indizes und Prozeduren profitieren von einer sauberen Namenskonvention.
Mithilfe von Konventionen können Datenbankentwickler eine projektübergreifende Wissensbasis aufbauen und somit Standards für zukünftige Projektarbeiten schaffen. Ein weiterer wichtiger Punkt ist die Eliminierung von Vermehrungen bzw. Doppeldeutungen in Variablen-, Funktions- oder Prozedurnamen, wie z.B. RowFetchDone oder FetchRowDone.
In der Praxis ist jede vorhandene Namenskonvention besser als gar keine. Durch die Schaffung einer Namenskonvention werden Entwickler dazu verpflichtet einen minimalen Standard einzuhalten.
Best Practices für ein Datenbankprojekt im Detail
Folgende Fragen sollte man sich stellen, wenn man eine Namenskonvention für ein Datenbankprojekt erstellen möchte und nicht genau weiß, wo man anfangen soll.
Ungarische-, CamelCase- oder Cleancode-Notation wählen?
Die Wahl der richtigen Notation ist der erste große Schritt, der schon viele Entscheidungen abnehmen kann, aber nicht alle Probleme löst.
Jede Notation hat ihre Vor- und Nachteile, die bereits in den vorherigen Artikeln beschrieben worden sind. Mit der Zeit wird sich mit großer Wahrscheinlichkeit herausstellen, dass eine gute Mischung aus Ansätzen der verschiedenen Notationen wohl der beste Weg sein wird, um eine langfristige Namenskonvention aufzubauen.
Wichtig bei der Wahl der Notation ist, dass man mit einer Grundlage beginnen und diese stets ausbauen sollte. Eine Grundlage für eine Namenskonvention kann die richtige Benennung von Tabellen, Indizes und Prozeduren sein, die nach einem festen Standard definiert sind.
Abkürzungen oder sprechende Namen für Datenbankobjekte verwenden?
Das Thema, ob Abkürzungen oder sprechende Namen verwendet werden sollen, ist ein ganz alter Hut, der schon viele Datenbankentwickler verrückt gemacht hat. Wichtig ist, dass wenn ein Projektteam an einer Datenbankapplikation arbeitet, dass jeder stets hinter den Richtlinien steht und diese konsequent befolgt.
Zeilenumbrüche, Codeeinrückungen und Zwischenräume sinnvoll?
In der Vergangenheit hat sich gezeigt, dass Zeilenumbrüche, saubere Codeeinrückungen oder Zwischenräume sinnvoll sind und dem Betrachter die Arbeit erheblich vereinfachen. Das menschliche Auge nimmt strukturierte Informationen viel schneller war, als unsaubere Fragmente, die eine code-ähnliche Struktur besitzen.
Kommentare sinnvoll einsetzen, aber wie?
Es wird ein Zeitpunkt im Projekt kommen, da weiß man nicht mehr genau, was man noch vor einigen Monaten oder Jahren mit diesem Codeelement erreichen wollte. Es kann auch vorkommen, dass man ein Unternehmen verlässt und eine Übergabe vorbereiten muss.
An diesem Punkt zeigt sich, ob der Aufbau sinnvoller Kommentare und die Erstellung einer sauberen Dokumentation richtig durchgeführt wurden. Je einfacher und schneller neue und bestehende Mitarbeiter eines Unternehmens Textfragmente lesen und verstehen können, desto schneller können sie Optimierungs- bzw. Wartungsarbeiten übernehmen und durchführen.