85B1DDA3DA0441AC8F574F6898A3E238
  • Internet
  • 01.01.2018
  • DE

webguys: Transparenz schaffen durch Namenskonventionen

geschrieben von Ingo Hillebrand, 15. April 2010
 

Selten kommt es vor, dass nur ein Entwickler an einem Projekt arbeitet. Auch wenn dies so sein sollte, wird sicherlich ein Kollege die Urlaubsvertretung machen müssen. Dies kann unschön werden, sofern unter den Entwicklern keine einheitliche Abspreche hinsichtlich der Benamsung von Platzhaltern  existiert.

Um ein Template übersichtlich zu halten emphielt es sich, eine übergreifende Namenskonvention zu erstellen. Dies schafft nicht nur Klarheit über den Platzhaltertyp, sondern auch in der Liste der vorhandenen Platzhaltern.  Projektübergreifende Verwendung spart Zeit und erleichtert den Einstieg in das Projekt.

Element-Typ   Vorschlag
Anchor   anc_name
Area   area_name
Attribute   att_type
Container   con_name
Frame   frm_name
Image   img_name
Überschrift   hdl_name
Info   inf_name
Liste   lst_name
Media   med_name
Optionsliste   opt_name
Standardfeld   stf_name
Text   txt_name


Das Standardfeld kann mehrere Ausprägungen annehmen, daher sind folgende Benamsungen ebenfalls sinnvoll:
Standardfeld (numerisch):
int_name

Standardfeld (e-Mail):
eml_name

Standardfeld (Datum):
dat_name

Am Ende entscheidet der persönliche Geschmack über die endgültige Konvention, empfehlen kann ich den Einsatz eines "internationen" Standards in englischer Sprache, um sich mit anderen Entwicklern auszutauschen.


Quelle: Transparenz schaffen durch Namenskonventionen

© copyright 2010 Ingo Hillebrand