projekty pojava
wymogi formalne
Dalsze wymagania:
- To są trzecie zajęcia.
- Pozostałe cztery spotkania mają charakter konsultacji.
- Wymagam byście Państwo pojawili się na dwóch z tych konsultacji z przygotowanym fragmentem projektu (można przynieść całość).
- Do wyboru jest pojawienie się na 4 i 6 zajęciach lub 5 i 7.
- Osoby, które przyjdą po raz pierwszy na zajęciach nr. 4, a drugi raz na zajęciach nr. 6 mają +0.5 do jakości wykonania programu.
Dodatkowe wymagania
- Na pierwsze konsultacje proszę przygotować min. dwa pytania: "jak to zrobić", gdzie chcecie w projekcie coś uzyskać a nie wiecie jak
- Na drugie konsultację proszę przygotować min. dwie rzeczy które chcecie w swoim programie poprawić.
- Program (i pytania) proszę przesłać do godziny 23.59 w sobotę poprzedzającą zajęcia na które przychodzicie.
- Te wymagania obowiązują grupy które je usłyszały na zajęciach :)
Wymogi formalne
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 i publiczna metoda ma swój opis (może być jedno zdanie).
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
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/
Kompilacja
Podana jest instrukcja kompilacji, w najlepszym przypadku za pomocą skryptu ANT, w najgorszym za pomocą Eclipse
projekty pojava wymogi formalne
projekty pojava formalne
By Jacek Bzdak
projekty pojava formalne
- 1,731
