9.dia Tiszta kód Flashcards
(8 cards)
Milyen a tiszta kód?
Olyan kód ami nem a szerző által is könnyen olvasható és fejleszthető.
Vannak hozzá egységtesztek és elfogadási tesztek.
Értelmes nevek, kevés függőség…
Tehát összegezve, az alapelveknek megfelelő kód, ami formailag is szép.
Értelmes nevek
Osztály -> főnév
Metódus -> ige
Olyan nevek, amelyekből kiderül a szándék, beszédes nevek.
Ne legyenek férevezetőek.
Valamint ne legyenek zajszavak ‘Data/Info’ amiket túl sokszor használnak a fejlesztők.
Mi a baj a megjegyzésekkel?
Szükséges rosszak. Ha tiszta a kód, akkor magáért beszél.
Gyakran közölnek pontatlan információt. Pl.: kód változik a megjegyzés meg nem.
Függvények
Nagyon rövidek legyenek, idálisan 2 sor.
Utasítás blokkok 1 sort tartalmazzanak, ami egy metódus hívás legyen.
Argumentumok:
Niladikus -> argumentum nélküli.
Monadikus -> 1 argumentum.
Diadikus -> 2 argumentum.
Triadikus -> 3 argumentum.
Poliadikus -> kerülendő >4 argumentum.
Jó és rossz megjegyzések fajtái
Jó megjegyzés:
Informatív, Szándékot magyarázó, tisztázó, következményekre figyelmeztető, TODO, megerősítő, Javadoc megjegyzések API-ban
Rossz megjegyzések:
Pozíció jelző, szerző neve, záró kapcsos zárójel, kötelező, félrevezető, fölösleges, motyogás (Ebből van több)
Forráskód formázása:
Vízszintes és függőleges, újság metafora
Legyen jól olvasható.
Függőleges formázás:
Sorok száma, ne legyen túl hosszú.
Újság metafora, a függvények neve legyen figyelem felkeltő, és ahogy megyünk lefele egyre részletekbe menő.
Vízszintes formázás:
Sorok hossza ne legyen túl hosszú, és ne legyenek benne tertedelések.
Hibakezelés, ellenőrzött és nem ellenőrzött kivételek
Részesítsük előnyben kivételeket, valamint használjunk nem ellenőrzött kivételeket.
Null átadás függvényeknek, null visszaadás
Nem szabad