template

Index :: HTML :: Konventionen für Skriptnamen

Selbst ein zunächst übersichtliches Projekt mit wenigen Seiten kann schnell anwachsen, und oft liegen nach der Testphase bereits ein gutes Dutzend von Skripten vor. Spätestens bei der Implementation von z.B. Benutzerverwaltung und diversen Assistenten (Auswahl, Download, Upload, Druckversion, Info-Popups usw.) ist ein Volumen von bis zu zwanzig Seiten erreicht.
Um hier den Überblick zu behalten, und bestimmte Dokumente schnell zu finden, sollte man sich bei der Vergabe von Skriptnamen an allgemeine Konventionen halten.

Möglichkeit für ein Namenssystem:

Muster Beispiel Bedeutung
todo_* todo_export.txt Projektnotizen (Text)
gen_* gen_persons.txt SQL-Anweisungen zur Tabellenerstellung (Generate)
imp_* imp_articles.txt SQL-Anweisungen od. CSV-Zeilen zum Import von Datensätzen
*list perslist.php Liste, evtl. mit Suchmaske
ed* edpers.php Bearbeiten/Neu-Dialog (Edit)
cho* chopers.php Auswahl-Dialog (Choose)
dn* dnorders.php Download-Dialog
up* uplist.php Upload-Dialog
inf* infpers.php Infoseite
hlp* hlplogin.html Hilfeseite
vw* vwmail.php Anzeige/Voransicht (View)
u* uordlist.php User-Seite
a* aordlist.php Admin-Seite
p_* p_perslist.php Druckversion (Print)
w_* w_edpers.php Popup (Window)
f_* f_main.php Framedefinition
_* _itemlist.php Frameseite
m_* m_mime.php PHP-Modul
t_* t_crypt.php PHP-Modul (Tool)
c* cMail.php PHP-Klasse
aj* ajorder.php PHP-Skript für AJAX-Anfragen

Auch die Unterordner des Projekts sollten kurze, prägnante Namen haben, z.B.:

Beispiel Inhalt
img Allgemein Grafiken, Icons
css Stylesheets
js Javascript-Module
vbs VBScript-Module
bmp Bildvorlagen, Grafiken (während der Entwicklung)
aud Audiodateien, z.B. Midi oder MP3
media Allgemein Mediadaten, z.B. Flash oder Videos
test Testskripte, Versuche
old Alte Seiten, evtl. Skriptvorlagen
doku Allgemein Dokumentationen, Infoseiten
hlp Hilfeseiten
transfer SQL-Dateien, ZIPs (während der Entwicklung)

Index :: HTML

template