Clean Code tarkoittaa helposti luettavaa, ylläpidettävää ja ymmärrettävää ohjelmakoodia. Hyvin kirjoitettu koodi säästää aikaa ja vähentää virheiden määrää.
Käytin allaolevissa esimerkeissä selkeyden vuoksi suomenkielisiä nimiä muuttujille ja funktioille. On kuitenkin suositeltavaa käyttää englanninkielisiä nimiä.
Käytä muuttujille ja funktioille nimiä, jotka kertovat niiden tarkoituksen selkeästi.
// Huono esimerkki
int f(int x, int y) {
return x * y;
}
// Hyvä esimerkki
int laskeHinta(int vero, int hinta) {
return vero * hinta;
Funktioiden tulisi tehdä vain yhtä asiaa ja tehdä se hyvin.
// Huono esimerkki
void prosessoiAsiakas(Asiakas asiakas) {
tallennaTietokantaan(asiakas);
lahetaSahkoposti(asiakas);
tulostaRaportti(asiakas);
}
// Hyvä esimerkki
void tallennaAsiakas(Asiakas asiakas) {
tallennaTietokantaan(asiakas);
}
void lahetaTervetuloSahkoposti(Asiakas asiakas) {
lahetaSahkoposti(asiakas);
Pidä koodin tyyli ja käytetyt nimet yhtenäisinä koko projektissa.
Hyvin nimetyt funktiot ja muuttujat tekevät kommenteista usein tarpeettomia.
// Huono esimerkki
// Funktio laskee summan
int sum(int a, int b) {
return a + b;
}
Koodi kannattaa pitää mahdollisimman modulaarisena ja eristää toiminnallisuudet erillisiin funktioihin tai luokkiin.