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.
Nazwy klas
interfejsów i typów wyliczeniowych
Wymagania
- Z dużej litery
- Pisane camelCase.
- Nazwy opisują klasę
- Po angielsku
Poprawne przykłady:
JButton, JFreeChart, DriverManager, FooBar, ComptonExperiment
Niepoprawne przykłady
- MojaKlasa, Frame, MyFrame - nazwa nic nie mówi o klasie
- compton_experiment - nie poprawny format nazwy
Nazwy zmiennych i metod
Wymagania
- Z małej litery
- Pisane camelCase.
- Nazwy opisują zmienną
- Po angielsku
Przykłady poprawne
- photonEnergyMeV, scatteringAngleDeg
- ii -- w przypadku zmiennych używanych w pętlach
Przykłady błędne
- zmienna, i -- nic nie mówi
- gamma_angle -- nie camelCase
Wcięcia w kodzie
- Proszę stosować się do używania wcięć w kodzie.
- Szczególnie, że Eclipse potrafi automatycznie formatować kod.
- Dodatkowo proszę pilnować maksymalnej długości linii na poziomie 100 znaków.
Komentarze
- Kod powinien być zrozumiały.
- I mieć jakieś komentarze, w wersji minimum: każda klasa ma swój komentarz
- Komentarze muszą dodawać informacje których nie można zgadnąć z nazwy klasy.
- 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
Jakość kodu
- Państwa program kompiluje się bez ostrzeżeń (przy włączonych wszystkich ostrzeżeniach: -Xlint)
- Zachęcam do korzystania z http://findbugs.sourceforge.net/