Ocena czystosci kodu

Question

Witam

chciałbym aby ktoś lepszy ocenił mój kod pod względem czystości kodu. Kod jest bardzo prosty ale mi chodzi tylko o nawyki na starcie. Przeczytałem książkę pt "Czysty kod" i chciałbym z niej trochę nawyków zaczerpnąć. Program jest napisany w Javie (której dobrze nie znam) jak ktoś ma jakieś uwagi co do samych funkcji języka to tez chętnie je rozpatrzę.

 

import java.io.IOException;
import java.io.PrintWriter;
import java.nio.file.Paths;
import java.util.Scanner;

public class main {

	public static void main(String[] args) throws IOException {
				
		showDirPath();
		
		
		Scanner in = new Scanner(Paths.get("mojplik.txt"));
		
		readFile(in);
		
		PrintWriter out = new PrintWriter("zapisPilku.txt");
		
		overwriteFile(out);
		
		out.close();
		
	}
	
	private static void showDirPath()
	{
		String dir =System.getProperty("user.dir");
		System.out.println(dir);
	}
	private static void readFile(Scanner in) 
	{
		while(in.hasNextLine())
		{
			String line= in.nextLine();
			System.out.println(line);
		}
	}	
	private static void overwriteFile(PrintWriter out)
	{
		String saveText = "Witaj zaisany pliku!";
		
		out.write(saveText);
	}
	
}

 

Answer 1

Zmienna saveText, nie jest dobrą nazwą, ponieważ zawiera czasownik save. Czasowników powinno się używać do nazw metod (bo metody zasadniczo coś robią). Bardziej by pasowało samo text, ewentualnie textToSave.

Answer 2

Trochę mało tego kodu aby coś ocenić :p Btw style-guide Javy nie mówi że klamry powinno się stawiać tak: 

void func() {
  // code
}

A nie "na piramidke" jak to zrobiłeś?

Comments

Do oceny chce podać głownie funkcje ( czy nazwy trafne i czy odpowiednio zbudowane)

A co do klamer to przyzwyczajenie z C++

---

Każdy ma własne upodobania co do klamer. Niektórych podniecają piramidki a innych TO COŚ. Ja jestem osobiście za piramidkami

---

Tylko, że wypada trzymać się standardu danego języka żeby zachować w miarę jednolity kod gdyby ten nasz miałby zostać włączony w coś większego. Nie uważasz?

---

Czyli sugerujecie ze powinienem przestawić się na nowy styl pisania klamer wbrew sobie (co oczywiście da się zrobić)?

Answer 3

To jest zbyt mało kodu by się nad nim szczególnie "pastwić". Jeśli jednak chcesz "czepialstwa" to nazwy obiektów systemu plików, wydzielił bym do statycznych stałych. Ale ogólnie jest 4+/5- :-P