von Matthias Kannengiesser, 06.03.2007

Teil 1: Tipps und Tricks rund um PHP und MySQL: PHP 5 & MySQL 5

Aus dem
t3n Magazin Nr. 7

Regel 7: Jede Funktion muss mit Kommentaren versehen werden – Eine der wichtigsten Aufgaben der Programmierung liegt in der Dokumentation. Das ist in einem Team unverzichtbar, nur so können die anderen Team-Mitglieder alle Funktionen verstehen, verbessern und nutzen.

Regel 8: Lange Kommentare sollten mit /* und kurze Kommentare mit // gemacht werden – Ein Kommentar beschreibt in der Regel eine Funktion, Methode oder einen ganzen Absatz des Quellcodes. Jedes Team sollte eine Entscheidung darüber fällen, in welcher Art und welchem Umfang Kommentare angewendet werden. Das erklärte Ziel jeder Dokumentation und jedes Kommentars muss Transparenz und Verständlichkeit für den Quellcode sein.

Regel 9: Sämtliche Bezeichner werden aussagekräftig und eindeutig definiert – In einem Programm können unzählige Bezeichner beziehungsweise Namen definiert werden. Jede Variable, Funktion, Klasse und so weiter benötigt einen Bezeichner. Sie müssen aussagekräftig und eindeutig definiert werden, sollten nicht zu lang, aber auch nicht zu kurz sein. Aussagekräftige Bezeichner sagen immer etwas über den Inhalt und die Verwendung aus.

$datenbank_nutzer = "xyz";
entferne_sonderzeichen();
class PersonalVerwaltung {...}

Listing 1

Regel 10: Benennung von Variablen und Funktionen erfolgen mit Unterstrich und in Kleinbuchstaben – Wie schon erwähnt, ist der Einsatz von Abkürzungen mit Vorsicht zu genießen. Um den Einsatz von Abkürzungen dennoch zu ermöglichen und Variablen eindeutig und mit mehreren Worten benennen zu können, verwendet man den Unterstrich zur Trennung der Wörter. Bei der Verwendung von Abkürzungen sollten Sie darüber hinaus darauf achten, dass sie nicht zweideutig sind.

Seite:  1 2 3 4 5 6 7

Empfohlene Artikel