projekty pojava 

wymogi formalne

edycja 2014


Jacek Bzdak

Dalsze wymagania:

  • Na następne zajęcia będę prosił przygotowanie pierwszej wersji interfejsu graficznego.
  • Do tego każdy zespół powinien przygotować dwa pytania: "Jak to zrobić" --- które opiszą dwie rzeczy które powinni zrobić w projekcie, a nie wiedzą jak (jeśli wydaje wam się że nie macie takich pytań to nie przemyśleliście projektu dostatecznie.




Wymogi formalne


Nazwy klas

interfejsów i typów wyliczeniowych
Wymagania
  1. Z dużej litery 
  2. Pisane camelCase. 
  3. Nazwy opisują klasę
  4. Po angielsku

Poprawne przykłady:

JButton, JFreeChart, DriverManager, FooBar, ComptonExperiment
Niepoprawne przykłady
  1. MojaKlasa, Frame, MyFrame - nazwa nic nie mówi o klasie
  2. compton_experiment - nie poprawny format nazwy

Nazwy zmiennych i metod

Wymagania
  1. Z małej litery 
  2. Pisane camelCase. 
  3. Nazwy opisują zmienną
  4. Po angielsku
Przykłady poprawne
  1. photonEnergyMeV, scatteringAngleDeg
  2. ii -- w przypadku zmiennych używanych w pętlach
Przykłady błędne
  1. zmienna, i -- nic nie mówi
  2. gamma_angle -- nie camelCase

Wcięcia w kodzie

  1. Proszę stosować się do używania wcięć w kodzie. 
  2. Szczególnie, że Eclipse potrafi automatycznie formatować kod.
  3. Dodatkowo proszę pilnować maksymalnej długości linii na poziomie 100 znaków.

Komentarze

  1. Kod powinien być zrozumiały.
  2. I mieć jakieś komentarze, w wersji minimum: każda klasa ma swój komentarz
  3. Komentarze muszą dodawać informacje których nie można zgadnąć z nazwy klasy.
  4. Proszę stosować komentarze JAVADOC. 

 Kwestia autorstwa

  • Każda klasa musi mieć określonego autora (albo dwóch autorów)
  • Autora klasy określamy w komentarzu klasy.
  • Brak określonego autora oznacza że klasę wykonały obie osoby.
  • Określenie autora będzie służyć do określenia zakresu pytań na kolokwium (nie będę pytać o szczegóły klasy osobę która nie jest jej autorem --- mogę pytać o ogólne informacje o klasie).


Paczka

Państwa kod powinien znajdować się w paczce: 

pl.edu.pw.fizyka.pojava.[[symbol zespołu]]

np:

pl.pw.edu.fizyka.pojava.a7

Dla zainteresowanych

  1. Java code conventions

Jakość kodu

  1. Państwa program kompiluje się bez ostrzeżeń (przy włączonych wszystkich ostrzeżeniach: -Xlint)
  2. Zachęcam do korzystania z http://findbugs.sourceforge.net/
Made with Slides.com