Piszemy programy

o tej pory poznaliśmy już podstawy pracy z językiem Java. Wiemy, dlaczego Java jest często wybierana do tworzenia aplikacji wieloplatformowych, jak przygotować środowisko programistyczne oraz co dzieje się z kodem źródłowym od momentu zapisania pliku .java aż do uruchomienia programu. Omówiliśmy również budowę pierwszego programu i wyjaśniliśmy znaczenie takich elementów jak package, class, metoda main, komentarze oraz instrukcja System.out.println.

Kolejnym krokiem jest nauczenie się nie tylko tego, jak napisać działający program, ale również tego, jak pisać kod w sposób czytelny i uporządkowany. Program może działać poprawnie, ale jeśli jest zapisany chaotycznie, trudno będzie go później poprawiać, rozwijać lub zrozumieć po kilku dniach przerwy. W pracy programisty czytelność kodu jest bardzo ważna, ponieważ kod często analizują także inne osoby.

W tej części materiału zwrócimy uwagę na zasady pisania przejrzystego kodu. Omówimy znaczenie wcięć, zapisywania każdej instrukcji w osobnej linii, stosowania zrozumiałych nazw zmiennych oraz dodawania komentarzy. Dzięki tym zasadom kod staje się bardziej czytelny, a jego analiza jest łatwiejsza zarówno dla autora programu, jak i dla innych programistów.

Warto pamiętać, że komentarze są szczególnie pomocne na początku nauki programowania. Pozwalają zapisać własnymi słowami, do czego służy dana instrukcja lub fragment algorytmu. Kompilator ignoruje komentarze, ale dla człowieka mogą one być bardzo cenną wskazówką. Dlatego w pierwszych programach warto komentować ważniejsze fragmenty kodu i stopniowo uczyć się dobrych nawyków programistycznych.

Celem tej części lekcji jest pokazanie, że dobry programista dba nie tylko o to, aby program działał, ale także o to, aby kod był przejrzysty, logiczny i łatwy do dalszej pracy.

Poniżej możesz pobrać przykładowe rozwiązanie.

Poniżej możesz pobrać przykładowe rozwiązanie.

Jak pisać przejrzysty kod?

W pracy programisty warto przestrzegać kilku zasad, aby napisany kod był czytelny i łatwy do analizowania. Należą do nich:

• używanie wcięć oraz umieszczanie każdej instrukcji w nowej linii:

public class PrzykladowaKlasa {

	public static void main(String[] args) {
		// TODO Auto-generated method stub
				System.out.println("Jestem programem");

	}
}

• stosowanie odpowiednich nazw zmiennych,

public class PrzykladowaKlasa {

	public static void main(String[] args) {
		int i = 10; // Zmienna i liczba elementów w tablicy
        
        //Wypisanie zartości zmiennej i
				System.out.println(i);

	}
}

• zapisywanie komentarzy.

//Klasa opisujaca ucznia
public class Uczen {

	public static void main(String[] args) {
		int i = 10; // Zmienna i liczba elementów w tablicy
        
        //Wypisanie zartości zmiennej i
				System.out.println(i);

	}
}

Na początku przygody z programowaniem powinno się umieszczać w kodzie wiele komentarzy objaśniających wykorzystane instrukcje (przekonasz się niebawem, jak łatwo jest zapomnieć, do czego służą poszczególne sekwencje komend). Komentarze ułatwiają także analizowanie zapisanego algorytmu innym osobom. Pamiętaj, że wyjaśnienia umieszczone w kodzie są ignorowane przez kompilator i nie zwiększają rozmiaru pliku wykonywalnego.

Oto sposoby zamieszczania komentarzy w kodzie programu:

• komentarz jednowierszowy: po wpisaniu dwóch znaków // (slash) pozostała część wiersza jest traktowana jako komentarz:

int a = b + c; // suma dwóch liczb

• komentarz wielowierszowy: rozpoczyna się sekwencją /* (slash, gwiazdka), natomiast kończy znakami */ (gwiazdka, slash) i może zająć więcej niż jedną linię:

int a = b + c; /* suma dwóch liczb,
ten komentarz zajmuje dwie linie */