Calitatea programului începe cu calitatea codului său sursă. Principalul factor al calității codului sursă al programului este lizibilitatea și înțelegerea acestuia. Este necesar să se formalizeze regulile de scriere a codului care vor face citirea și înțelegerea codului altcuiva. Regulile de formatare a codurilor ar trebui să fie uniforme pe tot parcursul proiectului. Și este foarte de dorit ca acestea să fie foarte asemănătoare între proiecte.
1. Formatarea codului
1.1. Structurarea textului
1.1.1. Lungimea șirului
Ar trebui să încercați să evitați linii mai lungi de 120 de caractere. Dacă șirul depășește această mărime, atunci trebuie să utilizați regulile de rupere a liniei.
1.1.2. Reguli de alimentare pentru linii
Dacă șirul are mai mult de 120 de caractere, trebuie să utilizați următoarele reguli de transfer:
- Puteți transfera după virgulă sau înaintea operatorului;
- Un șir portabil trebuie mutat în raport cu partea superioară cu un caracter de file;
- Transferurile trebuie să fie în stil UNIX.
este acceptabilă următoarea opțiune de transfer:
este acceptabilă următoarea opțiune de transfer:
1.1.3. Spații și file
Pentru a forma indiciile în cod, trebuie să utilizați filele. Spațiile nu sunt permise. motive:
1.1.4. Formatarea subordonării
Codul subordonat trebuie mutat de la caracterul principal, exact la un tab. Codul subordonat nu poate fi pe aceeași linie cu codul principal.
nu este corect să scrieți așa:
corect scrieți astfel:
1.2. Instrucțiuni, expresii
1.2.1. expresii
Este de dorit ca numai o singură expresie să fie prezentă în fiecare linie.
nu este corect să scrieți așa:
corect scrieți astfel:
1.2.2. Instrucțiunile dacă, altfel, în timp ce, etc.
Există două tipuri de instrucțiuni de scriere:
dacă corpurile tuturor părților instrucțiunii constau în nu mai mult de o expresie, instrucțiunea poate fi scrisă în formă
dacă corpul din cel puțin una din părți este alcătuit din mai mult de o expresie, atunci instrucțiunea trebuie scrisă sub formă
La scrierea instrucțiunilor, trebuie aplicată cu strictețe regula "1.1.4 Subordonarea formatării": corpul de instrucțiuni trebuie să fie deplasat cu un caracter tab la dreapta instrucțiunii. Arcușurile curry ar trebui să fie pe linii separate și ar trebui să fie la același nivel cu instrucțiunile.
nu este corect să scrieți așa:
corect scrieți astfel:
1.2.3. Instrucțiuni complicate
Instrucțiunile complexe trebuie împărțite pe linii în conformitate cu regulile de la punctul 1.2.2.
pot fi scrise ca
Se recomandă ruperea instrucțiunilor foarte complexe în câteva simple.
poate fi scris ca:
1.2.4. Formatarea tablourilor
Arrays care sunt scrise în mai multe rânduri trebuie formatate după cum urmează:
1.3. Linii și spații goale
1.3.1. Linii goale
1.3.2. lacune
După virgulă, trebuie să existe un spațiu. După punct și virgulă, dacă nu este ultima în linie (de exemplu, în instrucțiunea pentru), trebuie să existe un spațiu. Voturile nu sunt precedate de virgulă sau punct și virgulă. Toți operatorii trebuie să fie separați de un spațiu de la operanții de pe ambele părți. Nu puteți înlocui un spațiu cu un caracter de file.
Un exemplu de utilizare incorectă:
De asemenea, un singur spațiu poate fi utilizat pentru alocarea operatorilor:
Un exemplu de utilizare incorectă:
De asemenea, se utilizează spații atunci când se utilizează cicluri de formatare:
Un exemplu de utilizare incorectă:
Formatul tabelar cu filele nu trebuie utilizat.
Un exemplu de formatare incorectă:
Notă. prezența sau absența unui spațiu după ce regulile nu sunt reglementate.
1.4. alte
În expresiile complexe, se recomandă gruparea operațiilor folosind paranteze, indiferent dacă această prioritate este necesară pentru operațiuni sau nu.
2. Convenția de numire
2.1. Concepte generale
Nu folosiți sublinierea pentru a separa cuvintele din identificatori, acest lucru extinde identificatorii și face dificilă citirea.
Încercați să dați variabile, metode etc. nume "vorbind". Este de preferat să se utilizeze denumiri care descriu în mod clar și clar scopul și / sau semnificația entității.
Încercați să faceți numele identificatorului cât mai scurt posibil (dar nu în detrimentul lizibilității).
2.2. Denumirea variabilelor
Primul cuvânt logic trebuie să înceapă cu o mică literă, cuvintele logice rămase - cu un stil mare (Camel). De exemplu: $ testCounter. $ userPassword.
2.3. Metode și funcții de numire
Fiecare cuvânt logic trebuie să înceapă cu o majusculă (stil Pascal). De exemplu: CountVariable, ChangeUserPassword.
2.4. Prefixe variabile
PHP nu este un limbaj foarte tipic, și există doar trei grupe de tipuri în el: scalar, arrays și obiecte.
Arrays ar trebui să fie numit cu prefixul "ar", cu următorul cuvânt logic din titlu începând cu o literă de majuscule. De exemplu, $ arResult. $ arModifiedUsers.
Obiectele ar trebui să fie numite cu prefixul "ob", următorul cuvânt logic din titlu, care începe cu o literă mare. De exemplu, $ obElement. $ obUser.
Obiectul de clasă CDBResult trebuie să înceapă cu prefixul "db", următorul cuvânt logic din titlu începând cu o literă de majuscule. De exemplu, $ dbResult.
Tipurile scalare ar trebui să înceapă cu prefixe numai dacă este cunoscut cu precizie că au un anumit tip. De exemplu, în cod
variabila merge fără prefix, deoarece tipul său se modifică în timpul executării programului.
variabila vine cu un prefix, deoarece tipul său este în general cunoscut și nu se schimbă.
2.5. Denumirea clasei
Numele clasei trebuie să înceapă cu litera "C". Dacă clasa aparține unui modul, atunci numele "proprietar" al modulului ar trebui să meargă mai departe. Fiecare cuvânt logic trebuie să înceapă cu o literă de capital.
Un exemplu. CIBlockElement, CIBlockType, CSaleAffiliate.
Dacă o clasă este diferit pentru diferite baze de date și, în consecință, are o clasă de bază, cu o bază de date comună pentru toate metodele, clasa de bază trebuie să fie în numele lui, după „C“ simboluri conțin caracter „All“.
2.6. Accesibilitatea variabilelor membre și a metodelor de clasă
Deoarece nu avem alte metode pentru a organiza vizibilitatea și disponibilitatea variabilelor membre și a metodelor de clasă, trebuie aplicate următoarele reguli:
- variabilele și metodele care sunt private și care nu pot fi accesate de nimeni altul decât modulul însuși (adică, nici partea publică, nici alte module) trebuie să înceapă cu două subliniere. De exemplu, __CheckEmail. __arData. Aceste metode nu sunt descrise în documentație și pot fi modificate fără a asigura compatibilitatea;
- variabilele și metodele care sunt interne și care pot fi accesate numai de modulele de produs (adică partea publică nu trebuie să) trebuie să înceapă cu o subliniere. De exemplu, _CheckEmail. _arData. Aceste metode nu sunt descrise în documentația publică (dar este bine să fie descrise în documentul intern) și pot fi modificate fără a asigura compatibilitatea numai după notificarea tuturor angajaților;
- Alte metode și variabile membre sunt considerate publice, ar trebui descrise în documentație și nu pot fi modificate fără a asigura compatibilitatea.
2.7. Denumirea constantelor
Constantele trebuie să fie scrise cu majuscule și să aibă prefixul "BX_". De exemplu, BX_ROOT, BX_FILE_PERMISSIONS.
4. Limbaje de programare
4.1. Concept general
În orice limbaj de programare există așa-numitele idiomuri, adică modalități de utilizare a anumitor construcții. De exemplu, în limbajul PHP, astfel de idealuri includ forma unei înregistrări de buclă pentru elementele matriceale
Utilizarea idiomelor permite cititorului să sări peste fragmente de cod evidente și să se concentreze asupra lucrurilor semnificative și, de asemenea, să găsească fragmentele necesare în cod pentru construcții (idiomatice) specifice.
Este necesar să încercăm să folosim desenele general acceptate și să nu inventăm propriile lor modele.
mai bine să rescrieți în această formă
4.2. Exemple de idiomi
Idiomul operatorului "?"
5. Întrebări SQL
Fiecare operație SELECT. DIN. UNDE. COMANDA DE LA. GROUP BY. LUAREA trebuie să înceapă cu o nouă linie.
Regula pentru mutarea unui șir lung este aceeași ca în PHP. o nouă linie cu file.
Articole similare
-
10 Reguli de conduită cu agenți de pază din magazin, regulile de siguranță în viața de zi cu zi
-
4 Reguli ale istoriei ceremoniei de ceai japoneze, tipuri, organizarea de băuturi de ceai
Trimiteți-le prietenilor: