Advertisement
Not a member of Pastebin yet?
Sign Up,
it unlocks many cool features!
- Komentáře
- *komentovat vše
- *komentovat jednotlivé třídy, metody, výčty... Eclipse automaticky doplní signaturu, parametry, výstupy i výjimky ihned pozadání /**
- *při přidávání vlastní metody do cizí třídy použít @author jprijmeni
- *používat // TODO: Eclipse opět dokáže identifikovat a Mylin vyhodnocuje jako todo výrazy, navíc vpravo je tento řádek značen modře
- *komentovat celkovou činnost bloků, ne zjevné věci (např.tohle vypočítá obsah kruhu a ne tohle vynásobí proměnnou r číslem pí)
- Kód
- *do while(true)... přidávat Thread.sleep
- *pokud je některý kód uvažován jako přechodný, používat @Deprecated anotaci, aby to bylo zjevné (a nezapomnělo se na to)
- *jednoduché metody nesouvisející s náplní třídy dávat do Utils jako static
- *žádné warnings u překladu, žádné "žluté řádky" (obsolette užití se dají tolerovat, ale vyhazovat nepoužité proměnné, nevyužité importy...)
- *při commitu neexistují větší zakomentované bloky kódu (pokud nemají komentář s vysvětlením, proč tomu tak je)
- *nepoužívat bulharské konstanty - všechno definované jako static final
- *využívat všech výhod použité verze Javy (ie neexistuje for(i=0; i< a.size(); i++)... pokud je to iterovatelná kolekce, nebo se to dá převést na Enumerate, či přímo procházet)
- *členit třídy do správných balíčků - pokud odpovídající balíček neexistuje, vytvořit jej
- *jednotlivé definice beanů v xml konfiguracích kontextů členit podle významu a ideálně jednotlivé pasáže uvést komentářem
- *odstraňovat nevyužité importy, odstraňovat hluchý (nevyužitý) kód
- Odkazy jinam
- https://wiki.alfresco.com/wiki/Coding_Standards
- http://neversaw.us/2011/1/16/not-your-fathers-javascript/
- http://www.ibm.com/developerworks/web/library/wa-aj-when/index.html
- http://blog.ashodnakashian.com/2011/03/code-readability/
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement