Szabályok írása php-
a program minősége kezdődik a minőségi forráskód. A legfontosabb szempont a minőség, a forráskód a program az olvashatóság és érthetőség. Szükséges, hogy hivatalossá szabályainak kódot írni, hogy majd valaki más kód olvashatóbbá és érthető. kód formázási szabályok egységesnek kell lennie az egész projekt. És igen kívánatos, hogy ezek nagyon hasonlóak voltak a projektek között.
1. kód formázása
1.1. szöveg strukturálása
1.1.1. A vonal hossza
Meg kell próbálnia elkerülni vonalak hosszabb 120 karakternél. Ha egy sor meghaladja ezt a méretet, hogy kell használni a sortörés szabályokat.
1.1.2. feltételek newline
Ha a szöveg hosszabb, mint 120 karakter, akkor használja a következő átigazolási szabályok:
- transzfer lehetséges a tizedesvessző után, vagy az üzemeltető;
- a szállító által a karakterláncot kell tolódott képest a felső egy fület;
- transzferek kell lennie UNIX stílusban.
elfogadhatónak kiviteli alak következő transzfer:
elfogadhatónak kiviteli alak következő transzfer:
1.1.3. Szóköz vagy tab
Ha formázni a bemélyedés a kódot kell használni lapok. Használata tilos terek. Okok:
1.1.4. formázás alárendelés
Slave kódot át kell helyezni a fő pontosan egy tab karaktert. Slave kód nem lehet ugyanazon a vonalon, mint a fő.
Ez nem helyes, hogy írjon, mint ez:
a jogot, hogy írni, így:
1.2. utasítás kifejezése
1.2.1. kifejezések
Kívánatos, hogy minden sorban csak egy volt kifejezés.
Ez nem helyes, hogy írjon, mint ez:
a jogot, hogy írni, így:
1.2.2. Utasítás if, else, while stb
Engedélyezett kétféle írás utasítások:
Ha az egész test részeinek utasítások állnak legfeljebb egy kifejezés, az utasítás lehet írott formában
ha a test legalább az egyik rész több, mint egy kifejezés, az utasításokat kell írásos formában
Írásakor utasításokat szigorúan be kell tartani a szabályt „1.1.4 formázás alárendelés”: kézi test kell tolni egy fület jobbra a nagyon utasításokat. Nadrágtartók kell külön sorokba és legyen ugyanazon a szinten az utasítás.
Ez nem helyes, hogy írjon, mint ez:
a jogot, hogy írni, így:
1.2.3. összetett utasításokat
Komplex utasításokat kell osztani mentén a szabályoknak megfelelően az 1.2.2.
Ez felírható
Nagyon összetett utasításokat ajánlott osztva több egyszerűbb.
Ez felírható:
1.2.4. formázás tömbök
Tömbök, amelyek rögzítik több sorban kell formázni az alábbiak szerint:
1.3. Üres sorok és terek
1.3.1. üres sorok
1.3.2. rések
Miután a tizedes pont kell, hogy legyen hely. Miután egy pontosvessző, kivéve, ha ez az utolsó egy string (például instruktsiifor) üresen kell hagyni. Mielőtt a vessző vagy pontosvessző terek nem kerülnek. Minden piaci kell szóközzel elválasztva a operandusok mindkét oldalon. Cseréje egy szóközt a lap nem engedélyezett.
Egy példa a helytelen:
Csak egy helyet lehet használni, hogy elszigetelje a szereplők:
Egy példa a helytelen:
hézagok is használható, ha a formázás ciklus:
Egy példa a helytelen:
Táblázatos formában lapok használatával nem szabad használni.
Egy példa a helytelen formátum:
Megjegyzés. jelenléte vagy hiánya a hely után, ha a szabályokat nem szabályozott.
1.4. más
Az összetett kifejezéseket, akkor ajánlott csoportos műveleteket zárójelben, függetlenül attól, hogy szükség van-e vagy sem a elsődlegességét.
2. elnevezési
2.1. Általános fogalmak
Ne használja aláhúzás külön szavakat belül azonosítókat, akkor meghosszabbítja az azonosítók és nehezen olvasható.
Próbáld ki, hogy a változók, módszerek, és így tovább. „Szólva” neveket. Lehetőleg nevek, amelyek egyértelműen és pontosan leírják a cél és / vagy önérzetet.
Próbálja meg, hogy azonosítóneveket lehető legrövidebb (de nem rovására olvashatóság).
2.2. elnevezési változók
Az első logikai szót kell kezdődnie kisbetűvel, más szóval logikus - egy nagy (stílus Camel). Például: $ testCounter. $ Userpassword.
2.3. Elnevezése funkciók és módszerek
Minden logikai szót kell kezdődnie nagybetűvel (Pascal stílus). Például: CountVariable, ChangeUserPassword.
2.4. előtétek változók
PHP - nem különösebben tipizirovany nyelvet, és már csak három különböző csoportok értelmében: skalár tömbök és objektumok.
A tömböket kell elnevezni az előtag „ar”, míg a következő logikus szót a neve kezdődik nagybetűvel. Például a $ arResult. $ ArModifiedUsers.
Tárgyak kell elnevezni az előtag „ob”, míg a következő logikus szót a neve kezdődik nagybetűvel. Például a $ obElement. $ ObUser.
CDBResult objektumot kell kezdeni az előtag „db”, míg a következő logikus szót a neve kezdődik nagybetűvel. Például a $ dbResult.
Skaláris kell kezdeni előtag csak akkor, ha pontosan tudják, mit kapnak típusát. Például a kódot
változó nélkül az előtag, milyen típusú változások során a program.
változó előtagja, például típus általánosan ismert és nem változik.
2.5. elnevezési osztályok
Az osztály neve meg kell kezdeni a „C” betű. Ha az osztály tartozik a modult, akkor túl kell lépnie az „üzleti” a modul neve. Minden logikai szót kell kezdeni nagybetűvel.
Példa. CIBlockElement, CIBlockType, CSaleAffiliate.
Ha az osztály eltér a különböző adatbázisokban, és ennek megfelelően egy alap osztály közös adatbázisát az összes módszerre, az alap osztály legyen az ő neve után a „C” szimbólum tartalmaznak karakter „All”.
2.6. Elérhetőség tag változók és módszerek az osztály
Mivel nincs más megszervezésének láthatóság és hozzáférhetőség tagjainak változók és osztály módszerek, akkor a következő szabályokat alkalmazza:
- tagváltozóival és módszereket, amelyek a magán- és amely nem tud kapcsolatba lépni senkivel, kivéve a modul (azaz bármely részét az állami vagy egyéb egység), meg kell kezdeni a két aláhúzás karaktereket. Például, __CheckEmail. __arData. Ezek a módszerek nem a szakirodalomban leírt és meg lehet változtatni anélkül, hogy kompatibilitást;
- tagváltozóival és módszereket, amelyek a belső és amely képes kezelni csak modulokat a termék (azaz a részét a közönség nem is lehet), meg kell kezdeni egy aláhúzás. Például, _CheckEmail. _arData. Ezek a módszerek nem ismertetett nyilvános dokumentumok (de jó lenne leírni a belső), és változhatnak nélkül csak kompatibilitás értesítés után minden alkalmazott;
- Más módszerek és tagváltozóival minősülnek nyilvános, azokat a dokumentációban leírt és nem lehet megváltoztatni anélkül, hogy a kompatibilitás.
2.7. elnevezési állandók
Az állandók kell nagybetűvel írott és az előtag «BX_». Például, BX_ROOT, BX_FILE_PERMISSIONS.
4. programozási idiómák
4.1. általános fogalma
A programozási nyelvben vannak úgynevezett kifejezéseket, amelyet széles körben használnak módon használja azokat, vagy egyéb szerkezetek. Például, a PHP nyelv az ilyen ideomam tartalmazzák jelölés a tömb elemei ciklus
Használata kifejezésmód lehetővé teszi az olvasó, hogy kihagyja a nyilvánvaló darab kódot, és összpontosítani értelmes dolgokat, és megtalálja a kódot a kívánt darabjai a jellegzetes (köznyelvi) tervez.
Szükséges, hogy megpróbálja használni a közös tervezés helyett feltalálás saját.
jobb átírni ebben a formában
4.2. példák szólások
Idióma szereplő „?”
5. SQL lekérdezések
SELECT minden művelet. FROM. HOL. ORDER BY. GROUP BY. RENDELKEZŐ kell kezdeni egy új sort.
transzfer általában leghosszabb sor megegyezik a PHP. Új sor egy lapra.