Jakośc kodu :: 4programmers.net

Rejestracja:około 13 lat
Ostatnio:ponad 7 lat
Postów:44

Mam takie pytanie a raczej prośbę o wytykanie mi błędów w kodzie :D
Uczę się trochę Javy i chciałbym opinii osób które są lepsze "w te klocki" ode mnie.

Kod pisany dla rozwiązania zadania ze spoju:
http://pl.spoj.com/problems/PRIME_T/

program został przyjęty;

Pisałem go starając się używać w miarę obiektowo (przynajmniej mi się tak wydaje:D).
Chciałbym przyłożyć wagę do jakości kodu.
Liczę że ktoś powytyka mi błędy, że powinny być osobne klasy, itp.

Kopiuj


package liczby;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;

public class liczby
{

	public static void main(String [] args) throws NumberFormatException, IOException
	{
	    Liczbya liczby= new Liczbya();
	    liczby.setLiczba_testow();
	    liczby.ustaw_tablice_testow();
	    liczby.pobieraj_testy();
	    liczby.wypisz_wyjscie(); 
	}
	
}

// klasa obsługi programu 
class Liczbya 
{

	private BufferedReader br = new BufferedReader(new InputStreamReader(System.in));
	private PrintWriter print=new PrintWriter(new OutputStreamWriter(System.out), true);
	
	private int liczba_testow;
	private int[] tablica_testow; 

	//pobieranie ilosci testow do sprawdzenia
	public void setLiczba_testow() throws NumberFormatException, IOException
	{
		 do
	        {
			 liczba_testow=Integer.parseInt(br.readLine());        	
	        }while(liczba_testow>=100000);
	}
	
	// definicja tablicy testow
	public void ustaw_tablice_testow()
	{
		tablica_testow=new int[liczba_testow];
	}
	
	//wprowadzanie testow do tablicy
	public void pobieraj_testy() throws NumberFormatException, IOException
	{
		for(int i=0;i<tablica_testow.length;i++)
		{
			int x=0;
			do
			{
			   x=Integer.parseInt(br.readLine());   
			}while(x<0&&x>100000);
		
			tablica_testow[i]=x;        	
		}
	}
	
	//wykonywanie testow
    private boolean liczba_pierwsza(int liczba)
	{		
			int pier=(int) Math.sqrt((double)liczba);
			if(liczba==1)return(false);
			for(int i=2;i<=pier;i++)
			{
				if (liczba%i==0)
				{
					return(false);
				}
			}
			return(true);			
	}
    //wypisywanie wynikow testow 
    public void wypisz_wyjscie()
    {
        for(int e:tablica_testow)
	    {
		   if(liczba_pierwsza(e))
		   {
	   		      print.println("TAK");
		   }
		   else
		   {
	   		      print.println("NIE");
		   }
		}
	  
    }
    
}

bogdans

2013-12-23 06:02

bogdans2013-12-23 06:02

Moderator

Rejestracja:prawie 17 lat
Ostatnio:prawie 5 lat

Mi się ten kod nie podoba z dwóch powodów:

brak obsługi wyjątków: throws NumberFormatException, IOException,
komentowanie rzeczy oczywistych:

Kopiuj

    //wypisywanie wynikow testow 
    public void wypisz_wyjscie()

.
Poza tym nie przestrzegasz zalecanych reguł nazewniczych (wielkość liter, '_' w nazwach).
Pole print można zdefiniować prościej:

Kopiuj

PrintStream print = System.out;

MiL 2013-12-23 09:25

Lepiej 10 komentarzy więcej niż o 1 za mało.

bogdans 2013-12-23 09:58

Lepiej żaden, niż komentarze nic nie wnoszącyce.

~~Shalom~~ 2013-12-23 12:00

@MiL jesli musisz wstawić komentarz w kodzie, to znaczy ze kod jest złej jakości. Oczywiście nie dotyczy to javadoców dokumentujących publiczne API, ale i z tymi trzeba uważać bo zwykle kod się zmienia a komentarze pozostają te same i są po prostu blędne...

MiL 2013-12-23 14:54

O komentarzach można dyskutować długo ale ja uważam że są one potrzebne i powinno się je stosować. W większości projektów są miejsca wymagające komentarza a czasami są takie wałki że bez niego nie wiadomo o co chodzi. Takie życie, w idealnym świecie komentarze byłyby nieprzydatne :) Oczywiście jeżeli komentarz sobie a kod sobie to taka sytuacja tylko wprowadza zamęt.

~~Shalom~~ 2013-12-23 15:03

@MiL mam nadzieje że nigdy nie będę musiał z kim takim jak ty pracować w takim razie. Chodzi o to żeby w kodzie nie było takich miejsc które wymagają komentarza ani "wałków". Trzeba refaktorować kod, tak zeby cały czas był dobry, a nie dopisywać "na szybko" jakieś hacki. Code review przed każdym commitem plus wymóg pisania testów jednostkowych skutecznie eliminuje takie sytuacje. Bo do gównianego kodu trudno napisać testy, a nawet jak sie uda to kolega z zespołu nie pozwoli ci tego skomitować bo wie że za jakiś czas on moze dostać ten kod do utrzymania / modyfikacji...

Liczba odpowiedzi na stronę

Treść *

Treść

Podgląd

Kliknij, aby dodać treść...

Kliknij, aby dodać załącznik lub wklej ze schowka.

Instrukcja obsługi Markdown

Pomoc 1.18.8

Typografia

Edytor obsługuje składnie Markdown, w której pojedynczy akcent *kursywa* oraz _kursywa_ to pochylenie. Z kolei podwójny akcent **pogrubienie** oraz __pogrubienie__ to pogrubienie. Dodanie znaczników ~~strike~~ to przekreślenie.

Możesz dodać formatowanie komendami , , oraz .

Ponieważ dekoracja podkreślenia jest przeznaczona na linki, markdown nie zawiera specjalnej składni dla podkreślenia. Dlatego by dodać podkreślenie, użyj underline.

Komendy formatujące reagują na skróty klawiszowe: Ctrl+B, Ctrl+I, Ctrl+U oraz Ctrl+S.

Linki

By dodać link w edytorze użyj komendy lub użyj składni [title](link). URL umieszczony w linku lub nawet URL umieszczony bezpośrednio w tekście będzie aktywny i klikalny.

Jeżeli chcesz, możesz samodzielnie dodać link: <a href="link">title</a>.

Wewnętrzne odnośniki

Możesz umieścić odnośnik do wewnętrznej podstrony, używając następującej składni: [[Delphi/Kompendium]] lub [[Delphi/Kompendium|kliknij, aby przejść do kompendium]]. Odnośniki mogą prowadzić do Forum 4programmers.net lub np. do Kompendium.

Wspomnienia użytkowników

By wspomnieć użytkownika forum, wpisz w formularzu znak @. Zobaczysz okienko samouzupełniające nazwy użytkowników. Samouzupełnienie dobierze odpowiedni format wspomnienia, zależnie od tego czy w nazwie użytkownika znajduje się spacja.

Znaczniki HTML

Dozwolone jest używanie niektórych znaczników HTML: <a>, , , <kbd>, <del>, , <dfn>, <pre>, <blockquote>, <hr/>, ,  oraz <img/>.

Skróty klawiszowe

Dodaj kombinację klawiszy komendą notacji klawiszy lub skrótem klawiszowym Alt+K.

Reprezentuj kombinacje klawiszowe używając taga <kbd>. Oddziel od siebie klawisze znakiem plus, np <kbd>Alt+Tab</kbd>.

Indeks górny oraz dolny

Przykład: wpisując H2O i m2 otrzymasz: H₂O i m².

Składnia Tex

By precyzyjnie wyrazić działanie matematyczne, użyj składni Tex.

<tex>arcctg(x) = argtan(\frac{1}{x}) = arcsin(\frac{1}{\sqrt{1+x^2}})</tex>

Kod źródłowy

Krótkie fragmenty kodu

Wszelkie jednolinijkowe instrukcje języka programowania powinny być zawarte pomiędzy obróconymi apostrofami: `kod instrukcji` lub ``console.log(`string`);``.

Kod wielolinijkowy

Dodaj fragment kodu komendą . Fragmenty kodu zajmujące całą lub więcej linijek powinny być umieszczone w wielolinijkowym fragmencie kodu. Znaczniki ``` lub ~~~ umożliwiają kolorowanie różnych języków programowania. Możemy nadać nazwę języka programowania używając auto-uzupełnienia, kod został pokolorowany używając konkretnych ustawień kolorowania składni:

```javascript document.write('Hello World'); ```

Możesz zaznaczyć również już wklejony kod w edytorze, i użyć komendy by zamienić go w kod. Użyj kombinacji Ctrl+`, by dodać fragment kodu bez oznaczników języka.

Tabelki

Dodaj przykładową tabelkę używając komendy . Przykładowa tabelka składa się z dwóch kolumn, nagłówka i jednego wiersza.

Wygeneruj tabelkę na podstawie szablonu. Oddziel komórki separatorem ; lub |, a następnie zaznacz szablonu.

nazwisko;dziedzina;odkrycie
Pitagoras;mathematics;Pythagorean Theorem
Albert Einstein;physics;General Relativity
Marie Curie, Pierre Curie;chemistry;Radium, Polonium

Użyj komendy by zamienić zaznaczony szablon na tabelkę Markdown.

Lista uporządkowana i nieuporządkowana

Możliwe jest tworzenie listy numerowanych oraz wypunktowanych. Wystarczy, że pierwszym znakiem linii będzie * lub - dla listy nieuporządkowanej oraz 1. dla listy uporządkowanej.

Użyj komendy by dodać listę uporządkowaną.

1. Lista numerowana
2. Lista numerowana

Użyj komendy by dodać listę nieuporządkowaną.

* Lista wypunktowana
* Lista wypunktowana
** Lista wypunktowana (drugi poziom)

Składnia Markdown

Edytor obsługuje składnię Markdown, która składa się ze znaków specjalnych. Dostępne komendy, jak formatowanie , dodanie tabelki lub fragmentu kodu są w pewnym sensie świadome otaczającej jej składni, i postarają się unikać uszkodzenia jej.

Dla przykładu, używając tylko dostępnych komend, nie możemy dodać formatowania pogrubienia do kodu wielolinijkowego, albo dodać listy do tabelki - mogłoby to doprowadzić do uszkodzenia składni.

W pewnych odosobnionych przypadkach brak nowej linii przed elementami markdown również mógłby uszkodzić składnie, dlatego edytor dodaje brakujące nowe linie. Dla przykładu, dodanie formatowania pochylenia zaraz po tabelce, mogłoby zostać błędne zinterpretowane, więc edytor doda oddzielającą nową linię pomiędzy tabelką, a pochyleniem.

Skróty klawiszowe

Skróty formatujące, kiedy w edytorze znajduje się pojedynczy kursor, wstawiają sformatowany tekst przykładowy. Jeśli w edytorze znajduje się zaznaczenie (słowo, linijka, paragraf), wtedy zaznaczenie zostaje sformatowane.

Ctrl+B - dodaj pogrubienie lub pogrub zaznaczenie
Ctrl+I - dodaj pochylenie lub pochyl zaznaczenie
Ctrl+U - dodaj podkreślenie lub podkreśl zaznaczenie
Ctrl+S - dodaj przekreślenie lub przekreśl zaznaczenie

Notacja Klawiszy

Alt+K - dodaj notację klawiszy

Fragment kodu bez oznacznika

Alt+C - dodaj pusty fragment kodu

Skróty operujące na kodzie i linijkach:

Alt+L - zaznaczenie całej linii
Alt+, Alt+ - przeniesienie linijki w której znajduje się kursor w górę/dół.
Tab/⌘+] - dodaj wcięcie (wcięcie w prawo)
Shit+Tab/⌘+[ - usunięcie wcięcia (wycięcie w lewo)

Dodawanie postów:

Ctrl+Enter - dodaj post
⌘+Enter - dodaj post (MacOS)

Jakośc kodu

dawid918

bogdans

Smileys & People

Animals & Nature

Food & Drink

Travel & Places

Activities

Objects

Symbols

Typografia

Linki

Wewnętrzne odnośniki

Wspomnienia użytkowników

Znaczniki HTML

Skróty klawiszowe

Indeks górny oraz dolny

Składnia Tex

Kod źródłowy

Krótkie fragmenty kodu

Kod wielolinijkowy

Tabelki

Lista uporządkowana i nieuporządkowana

Składnia Markdown

Skróty klawiszowe

Praca dla programistów

Forum dyskusyjne

Sprawy administracyjne

O nas

Skontaktuj się z nami