Zend kódolási konvenciók 1.rész

Egy jó kódolási szabvány nélkülözhetetlen bármilyen fejlesztésről is beszélünk. Különösen igaz, ha egyszerre több fejlesztő is dolgozik ugyanazon a projekten. A kódolási konvenciók a forráskód minőségét segítik fenntartani, megőrizni. Ez pedig könnyebb olvashatóságot és kevesebb hibát fog eredményezni.

PHP file formázás:
  • a tisztán php tartalamú fájlokban ne alkalmazzuk a php záró taget
  • a behuzások tabok helyett 4 szóköznyiek legyenek
  • a sorok 80 karakter hosszúságúak legyenek maximum a könnyű olvashatóság miatt
  • a sorok LF (0×0A) jellel végződjenek ne pedig CR/LF kombinációval

Elnevezési konvenciók

Osztályok:

  • csak alfanumerikus karaktereket tartalmazhatnak, a számokat ne használjuk, aláhúzást csak a nevekben történő elválasztás miatt használjuk
  • többszótagú nevek esetében minden új szó nagybetűvel kezdődjön
  • az összes Zend vagy partnerei által készített osztályoknak “Zend_” megnevezéssel kell kezdődniük és a Zend/ könyvtárban kell lenniük, amelyeket a Zend nem hitelesített azokat viszont nem szabad itt elhelyezni
Interfészek:
  • Ugyanazok az elnevezési szabályok vonatkoznak rá, mint az osztályokra de az elnevezés végén szerepel az Interface szó.
Fájlnevek:
  • Az összes fájlnévben csak az alfanumerikus karakterek, aláhúzás illetve a kötőjel használata megengedett. Bármilyen fájl, ami PHP kódot tartalmaz a kiterjesztésének “.php” -nak kell lennie kivéve a View Scripteket.
Függvények nevei:
  • csak alfanumerikus karaktereket tartalmazhat, aláhúzás nem megengedett, számok használata kerülendő.
  • kisbetűvel kell kezdődnie
  • több részből álló neveknél az első szó kezdőbetűje kisbetű és az összes többi szó kezdőbetűje nagy, ez a “camelCase” néven ismert elnevezés.
  • az elnevezések hossza lehetőleg minimális legyen és az érthetőségre és praktikusságra törekedjen
  • az osztályváltozók beállító metódusai “get” illetve “set” előtaggal kell kezdődniük
  • a függyvények globális használata kerülendő, ezeket inkább egy statikus osztályba gyűjtsük
Eljárások nevei:
  • minden esetben kisbetűvel kell hogy kezdődjön
  • az elnevezés a minta nevét szükségszerűen tartalmazza
  • a privát vagy protected eljárások neveinek aláhúzással kell kezdődnie
Változók nevei:
  • csak alfanumerius karaktereket tartalmazhat, aláhúzás nem megengedett, a számok használatát, ha lehet kerüljük
  • kisbtűvel kezdődjön és a “camelCase” konvenciót használjuk
  • a privát vagy protected osztályváltozók neveinek aláhúzással kell kezdődnie
  • az elnevezések hossza lehetőleg minimális legyen és az érthetőségre és praktikusságra törekedjen
Állandók nevei:
  • tartalmazhat alfanumerikus karaktereket, aláhúzást és számokat is
  • mindig csupa nagybetűket használjunk
  • több részből álló neveknél a részeket aláhúzással válasszuk el egymástól
  • osztály részeként hozzuk létre a const kulcsszóval
  • kerüljük a globális hatókörű konstansokat
Digg This
Reddit This
Stumble Now!
Buzz This
Vote on DZone
Share on Facebook
Bookmark this on Delicious
Kick It on DotNetKicks.com
Shout it
Share on LinkedIn
Bookmark this on Technorati
Post on Twitter


A bejegyzés kategóriája:Programozás, ZF Certificate and tagged . Vedd fel a kedvencek közé: link. Szólj hozzá vagy hagyj egy trackback-et:Trackback URL.

Egy Trackback

  1. [...] Kódolási szabványok [...]

Szólj hozzá

Hozzászólás küldéséhez Be kell jelentkezni