Door
PHP Scripter
op 04-12-2011 16:27
gewijzigd op 04-12-2011 16:31
7.716 views
Momenteel ben ik bezig met het schrijven van een applicatie in PHP m.b.v. CodeIgniter die redelijk complex is.
Nu loop ik soms vast op de naamgeving binnen PHP, CSS etc.. Hoe pakken jullie dit aan? Nadat een gebruiker inlogd is komt hij op het dashboard van zijn account terecht. Hier ziet hij ook de login geschiedenis die de naam getLoginHistoryByID binnen PHP heeft. Is dat logisch?
Verder ben ik van plan om ook alle images namen en alle CSS content op de PHP manier te gaan verwerken. Zoiets als headerBackground en #headerMenu.
Graag zou ik hierover wat tips willen ontvangen omdat ik nu volgens mij te perfectionistisch te werk ga en ik op sommige dingen dus vast loop omdat ik continu bezig ben met de naamgeving.
Hier ziet hij ook de login geschiedenis die de naam getLoginHistoryByID binnen PHP heeft.
Waarom ziet de gebruiker de naam van de method?
Verder ben ik van plan om ook alle images namen en alle CSS content op de PHP manier te gaan verwerken. Zoiets als headerBackground en #headerMenu.
Let er wel op dat je jezelf niet gaat 'beperken' door dit te doen, zorg ervoor dat je dit consistent doet zodat je geen overbodige css elementen krijgt.
P.S. De naamgeving die je gebruikt 'klopt', zorg er ook voor duidelijke benamingen voor (private) fields.. sommige mensen gebruiken underscores om aan te duiden dat het om een private field gaat, andere geven ook alle fields een prefix ( private $sName, die 's' van 'string', 'i' van integer, 'b' van boolean.. etc)
Jaron, bedankt voor jouw reactie. De gebruiker ziet de naam van de method niet, maar ik doelde meer op de functie die ik in de view gebruik, qua naamgeving.
De benaming voor 'fields' is het probleem niet, maar meer de benaming voor functies etc.. Mijn 'probleem' zit hem er dus meer in dat ik niet weet of ik het goed doe qua naamgeving binnen PHP, CSS etc., ook al is het persoonlijk. En daar loop ik dus soms op vast en maak ik mezelf helemaal gek.
In CSS gebruik ik altijd naam-van-id (voorbeeld: #header-menu)
En in PHP gebruiker in de standaard van Zend. (voorbeeld: getUser, getEmail, getBla, setAah)
Ik vind het overigens heel belangrijk dat je in de naam aangeeft waar de functie over gaat. Dan is commentaar ook overbodig .. ;-)
Je zou ook eens kunnen kijken naar de Zend Coding Standards ook al ontwikkel je niet in Zend Framework, dan heb je alsnog hele goede richtlijnen over het gebruik van accolades, namen voor functies, classes, variabelen, etc!
Maar doe je dan ook bijvoorbeeld in de user class:
getNameByID
getEmailByID
Of laat je dat 'ByID' helemaal weg omdat het vanzelfsprekend is?
Nee zeker niet ById weghalen, want je kan later ook andere methods hebben (getByEmailAddress etc).. dynamisch maken is ook een oplossing maar niet zo net.
