Convenții de programare

De la WikiLabs
Jump to navigationJump to search

La laboratorul de POO se va puncta și modul în care un program este paginat, tabulat, modul în care sunt denumite clasele, metodele și variabilele, și, în general, modul în care codul este structurat. Regulile care trebuie respectate sunt:

  • se evită utilizarea de inner-class, deci într-un fişier Java se definește o singura clasă;
  • segmentele fişierului apar în următoarea ordine:
    • comentariul de introducere (header) care descrie pe scurt rolul clasei;
    • declaraţia de pachet (dacă există);
    • directivele de import;
    • declaraţia de clasă / interfaţă;
    • declaraţiile de câmpuri, toate identate cu un tab, în următoarea ordine:
      • câmpuri statice;
      • câmputi dinamice;
      • constante de clasă;
    • constructori, de la cel mai puţin complex la cel mai complex (neidentate);
    • metode (neidentate);
    • comentariul de final (footer);
  • toate segmentele fişierului sunt despărţite printr-o linie-comentariu ce apare inclusiv între constructori şi între metode;
  • metoda main, dacă există, este plasată între constructori şi metode;
  • pentru instrucţiuni if / do-while / for / case, şi pentru blocul metodelor, acolada care deschide blocul de instrucţiuni se află pe aceeaşi linie cu instrucţiunea / declaraţia iniţială iar acolada de final se află pe o linie separată, pe aceeaşi coloana cu prima literă din instrucţiune / declaraţie;
  • un bloc de instrucţiuni este identat cu un tab faţă de nivelul imediat superior;
  • numele de clase, implicit constructori, încep cu majusculă.
  • numele de metode încep cu litera mică;
  • numele de câmpuri încep cu litera mică;
  • numele de constante sunt scrise numai cu majuscule, cuvintele fiind desparţite prin "_";
  • argumentele și variabilele locale ale metodelor sunt declarate imediat sub declaraţia metodei, neidentate, şi încep cu caracterul “_”, având a doua literă mică. Excepţie fac contorii de cicli: i, j, k;
  • numele trebuie să fie cât mai sugestive în ceea ce priveşte scopul, pentru a evita comentariile excesive;

Aceste convenții de scriere a codului sunt doar un minim necesar(și obligatoriu) pentru laboratorul de POO. Pentru cei ce vor să cunoască tot setul de convenții recomandat de Oracle, îl pot găsi online.