Kod 藕r贸d艂owy jak dobre czasopismo? 馃檪

czytanie obraz

W niniejszym wpisie przedstawi臋 w jaki pozytywny spos贸b mo偶na wykorzysta膰 zasady znane z czasopism podczas pisania kodu 藕r贸d艂owego. Zaprezentuj臋 struktur臋 artyku艂u w czasopi艣mie oraz om贸wi臋 jak mo偶na odnie艣膰 t臋 struktur臋 do struktury kodu 藕r贸d艂owego. Okazuje si臋, 偶e czasopisma, magazyny, ksi膮偶ki mog膮 mie膰 wiele wsp贸lnego z kodem 藕r贸d艂owym 馃檪.

Struktura czasopisma

Zazwyczaj czasopismo zwi膮zane jest z wybran膮 dziedzin膮 偶ycia, nauki. Mamy na przyk艂ad czasopisma historyczne, samochodowe, dla graczy komputerowych, opisuj膮ce zdrowy tryb 偶ycia i wiele innych. Czasopismo sk艂ada si臋 z wielu artyku艂贸w. Artyku艂 w czasopi艣mie zazwyczaj sk艂ada si臋 z nast臋puj膮cych element贸w:

  • tytu艂 artyku艂u,
  • og贸lny opis artyku艂u,
  • akapity/paragrafy artyku艂u.
kod 藕r贸d艂owy jak dobre czasopismo - struktura artyku艂u
Elementy wyst臋puj膮ce w artykule z czasopisma

Dzi臋ki takiej strukturze czasopisma mo偶emy sprawnie nawigowa膰 pomi臋dzy artyku艂ami oraz sprawnie czyta膰 interesuj膮ce nas tematy. Je偶eli tytu艂 artyku艂u w czasopi艣mie jest dla nas interesuj膮cy, to zagl膮damy do og贸lnego opisu artyku艂u. Je偶eli og贸lny opis artyku艂u jest dla nas interesuj膮cy, to zagl膮damy do tre艣ci artyku艂u (do akapit贸w artyku艂u).

Struktura kodu 藕r贸d艂owego

Mo偶emy wykorzysta膰 struktur臋 czasopisma podczas pisania kodu 藕r贸d艂owego. Wybrane czasopismo mo偶emy por贸wna膰 z programem komputerowym. Artyku艂y z czasopisma mo偶emy por贸wna膰 do klas, z kt贸rych sk艂ada si臋 program. Elementy sk艂adowe artyku艂u z czasopisma mo偶emy nast臋puj膮co por贸wna膰 do element贸w klasy w programowaniu:

  • tytu艂 artyku艂u = nazwa klasy,
  • og贸lny opis artyku艂u = g艂贸wna metoda klasy, kt贸r膮 warto umie艣ci膰 na pocz膮tku klasy,
  • akapity artyku艂u = metody klasy, kt贸re warto umie艣ci膰 poni偶ej g艂贸wnej metody.

Dzi臋ki takiej strukturze kodu 藕r贸d艂owego mo偶emy sprawnie nawigowa膰 pomi臋dzy klasami oraz sprawnie czyta膰 interesuj膮cy nas kod 藕r贸d艂owy. Je偶eli nazwa klasy jest potencjalnie t膮 klas膮, kt贸r膮 chcemy znale藕膰 to zagl膮damy do g艂贸wnej metody klasy. G艂贸wna metoda powinna znajdowa膰 si臋 na pocz膮tku definicji klasy. Je偶eli g艂贸wna metoda klasy zawiera elementy, kt贸re nas interesuj膮, to zagl膮damy do konkretnych metod, kt贸re s膮 wywo艂ywane w g艂贸wnej metodzie.

Konkretna metoda w klasie np. methodA() (nieb臋d膮ca g艂贸wn膮 metod膮 klasy) mo偶e wywo艂ywa膰 inne kolejne metody np. methodA1() i methodA2(). Je偶eli jeste艣my zainteresowani poznaniem szczeg贸艂贸w metody methodA() to przechodzimy do kolejnych metod methodA1() i methodA2(). Metoda methodA1() mo偶e wywo艂ywa膰 inne kolejne metody …, itd. 馃檪. Otrzymujemy nast臋puj膮c膮 hierarchi臋 element贸w w klasie:

class ClassA {

    public void mainMethod() {
        methodA();
        methodB();
    }

    private void methodA() {
        methodA1();
        methodA2();
    }

    private void methodB() {
    }

    private void methodA1() {
    }

    private void methodA2() {
    }

}

Klasa mo偶e sk艂ada膰 si臋 z wielu g艂贸wnych metod. Dla cel贸w tego artyku艂u, klasa sk艂ada si臋 z pojedynczej g艂贸wnej metody. Powy偶szy kod 藕r贸d艂owy mo偶emy prze艂o偶y膰 na nast臋puj膮cy przyk艂ad zawieraj膮cy konkretne nazwy element贸w kodu 藕r贸d艂owego:

class OrderService {

    public void makeOrder() {
        calculateDiscounts();
        pay();
    }

    private void calculateDiscounts() {
        calculateRegularDiscounts();
        calculateSpecialDiscounts();
    }

    private void pay() {
    }

    private void calculateRegularDiscounts() {
    }

    private void calculateSpecialDiscounts() {
    }

}
Podsumowanie:
  • dzi臋ki wykorzystaniu struktury kodu 藕r贸d艂owego od og贸艂u do szczeg贸艂u mo偶emy sprawnie nawigowa膰 pomi臋dzy klasami oraz sprawnie czyta膰 kod 藕r贸d艂owy,
  • wykorzystuj膮c struktur臋 kodu 藕r贸d艂owego od og贸艂u do szczeg贸艂u, zg艂臋biamy si臋 w szczeg贸艂y kodu na tyle, na ile jest to konieczne. Nie musimy traci膰 czasu na czytanie i analizowanie ca艂ego kodu 藕r贸d艂owego.

Dzi臋kuj臋 za przeczytanie artyku艂u 馃檪.

2 my艣li na “Kod 藕r贸d艂owy jak dobre czasopismo? 馃檪”

  1. Pingback: Metoda main - czy warto po艣wi臋ci膰 jej wi臋cej uwagi? - Konstrukcja oprogramowania

  2. Pingback: Prawa De Morgana w programowaniu - Konstrukcja oprogramowania

Dodaj komentarz

Tw贸j adres email nie zostanie opublikowany. Pola, kt贸rych wype艂nienie jest wymagane, s膮 oznaczone symbolem *