13. Hyvä ohjelmointitapa (osa 1) 13.1
Yleistä Ohjelman elinkaari ei tyypillisesti pääty sen toteuttamiseen tarvitaan ylläpitoa. Jotta koodin muuttaminen on mahdollista, on sen oltava myös muidenkin kuin tekijänsä ymmärrettävissä. Pitkän ja monimutkaisen ohjelman ymmärtäminen voi olla vaikeaa vaikka ohjelma on tehty hyvin. Huonoa koodia ei välttämättä ymmärrä edes koodin tekijä! 13.2
Yleistä Hyvää ohjelmointitapaa noudattamalla saadaan aikaiseksi ymmärrettäviä ja hallittavia ohjelmia. Perusasioita: Nimeä tunnukset järkevästi. Kommentoi riittävästi ja oikeissa paikoissa. Sisennä koodia. Käytä vakioita. Rivitys: käytä välirivejä ja vältä liian pitkiä rivejä. Lisää ohjeita kurssin edetessä. 13.3
Nimeä järkevästi Tunnusten (nimien) tulee olla järkeviä. Nimestä tulisi voida päätellä esimerkiksi mitä tietoa muuttuja sisältää. Usein järkevä nimi on yhtä kuin riittävän pitkä nimi. Noudata nimeämiskäytäntöäsi johdonmukaisesti. Vakiintuneita käytäntöjä Javassa: Muuttujien nimet alkavat pienellä kirjaimella. Luokkien nimet alkavat isolla kirjaimella. Vakiot kirjoitetaan isoin kirjaimin. 13.4
Kommentoi Kommentit kannattaa kohdistaa erityisesti koodin keskeisiin osiin ja vaikeasti ymmärrettäviin osiin. Pitemmässä ohjelmassa ei tarvitse kommentoida kaikkea. Ohjelman alkuun kannattaa kirjoittaa kommentti, josta käy ilmi mitä ohjelma tekee ja kuka ohjelman teki. /* * Ensimmäinen harjoitustyö: Muutetaan suomenkielinen viesti * morsekoodiksi ja päinvastoin. * * Lausekielinen ohjelmointi, syksy 2009, Jorma Laurikkala, jpl@cs.uta.fi. * * Viimeksi muutettu 16.10.2009 15:11:45. * */ public class Morse { 13.5
Sisennä Sisennys auttaa hahmottamaan kokonaisuuksia. Sisennyksellä osoitetaan lauseiden looginen ja/tai kieliopillinen yhteenkuuluvuus. Välilyönnein (harjoitustöissä) tai tabulaattorilla: Kukin sisennyksen taso 2-4 välilyöntiä. Sekä tavalliset lauseet että kommentit samalle tasolle. Huomaa, että tabulaattorilla sisennettäessä koodi näyttää melko varmasti erilaiselta muissa editoreissa. Välilyöntejä ja tabulaattoreita ei saa käyttää sekaisin. 13.6
Sisennä Käytännössä kaikkien koottujen lauseiden sisältö sisennetään. Tasot: ohjelman, mainoperaation, ohjausrakenteen, sisemmän ohjausrakenteen koottu lause jne. Myös ohjausrakenteeseen liittyvä yksittäinen lause sisennetään. Ole johdonmukainen sisennyksissä: kullakin tasolla aina sama määrä sisennystä. Esim. while (jatketaan) { // Tulostetaan System.out.println( ); // Päivitetään lippumuuttuja. if ( ) { jatketaan = false; else jatketaan = true; 13.7
Sisennä Sisäkkäiset if-elserakenteet esitetään joskus tilanpuutteen vuoksi siten, että sisemmän lauseen ifosan otsikkorivi kirjoitetaan ulomman lauseen elseosan otsikkoriville. Tällöin rakenteen otsikkorivit ja koottujen lauseiden sisältö alkavat samalta tasolta. Esim. if (valinta == LISAA) { // Lisätään.... else if (valinta == HAE) { // Haetaan....... else { // Virhe.... 13.8
Käytä vakioita Vakioiden tunnus kirjoitetaan ISOIN KIRJAIMIN. Esim. final String LOPPU = "Ohjelma lopetettu. Kiitos käytöstä!"; Vakiot määritellään yleensä ohjelman alussa. Helpottavat ohjelmien ylläpitoa, esimerkiksi tilanteissa, joissa arvo on suojattava muutoksilta, sama arvo esiintyy ohjelmassa useassa kohtaa ja ohjelmaa käytetään näppäimistöltä annettavilla komennoilla. 13.9
Rivitys Osoita lauseiden looginen yhteenkuuluvuus kootun lauseen sisällä välirivejä käyttämällä. // Erota lauseita näin: while (jatketaan) { // Luetaan syöte. System.out.println( ); int luku = In.readInt(); // Tulostetaan System.out.println( ); Älä siis sisennä eri tasoille kootun lauseen sisällä, ellei kyseessä ole sisemmän kootun lauseen sisältö. // Ei _koskaan_ näin: while (jatketaan) { // Luetaan syöte. System.out.println( ); int luku = In.readInt(); // Tulostetaan System.out.println( ); Pitkät rivit ovat vaikeaselkoisia ja näkyvät vain osin pienessä ikkunassa: katkaise rivit noin 80 merkin kohdalta, mikäli mahdollista. 13.10