Reguli de codificare în Java

Aceste reguli sunt adoptate în compania noastră. Acestea vă permit să facă codul mai ușor de citit și de precisă pentru a evita erorile asociate cu diferite stiluri de a scrie cod pentru persoanele care lucrează la proiect, iar viitorul este ușor să-l modificați.

Numele de fișiere, pachete

  • Numele pachetelor sunt folosite doar litere mici.
  • Numele Java-class sunt date în conformitate cu notația Java standard.
  • nume de clase ar trebui să fie substantive, prima literă a fiecărui cuvânt - cu majuscule.
  • Numele de web-foldere și fișiere sunt folosite litere doar litere mici. Cuvintele în numele logoreic separate prin subliniere.

nume de metode, variabile

  • Metodele numele trebuie să fie verbe, prima literă ar trebui să fie litere mici, primele litere ale cuvintelor interne - majuscule.
  • Numele de variabile trebuie să înceapă cu o literă mică, cuvinte interne - cu un capital.
  • Numele constante sunt compuse din majuscule, împărțite în cuvinte, cu un caracter de subliniere.

Indents, lungime linie pauze, linie

  • Indentări ar trebui să fie strict 4 spații (nu un tab).
  • Lungimea șir nu trebuie să depășească 80 de caractere.
  • În cazul în care expresia este mai lung decât lungimea liniei, este necesar să-l rupe în mai multe rânduri în conformitate cu următoarele reguli:
    1. transferul după virgulă;
    2. transfer la operator;
    3. trebuie să utilizați liniuța 8 spații pentru a se referi la al doilea rând al expresiei divizate. Liniile ulterioare sunt aliniate pe linia a doua sau adaugă noi spații 8 pentru a indica cuiburi.

Locație blocuri, operatori, spații, paranteze

structurarea codului

  • Metodele trebuie să fie scurt, și de a efectua doar o singură sarcină (de exemplu, aproape orice ciclu este deja demn să-l aducă la o metodă specială).
  • nume de metode ar trebui să fie auto-explicative.
  • șabloane PLO ar trebui să fie utilizate pentru a structura și ușurința de citire.

articole similare