14. Hyvä ohjelmointitapa 14.1

Transkriptio

1 14. Hyvä ohjelmointitapa 14.1

2 Yleistä Ohjelman elinkaari ei tyypillisesti pääty sen toteuttamiseen; ohjelmaa voidaan käyttää ja ylläpitää jopa vuosikymmeniä. Jotta koodin muuttaminen on mahdollista, sen on oltava muidenkin kuin tekijänsä ymmärrettävissä. 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. Rivitys: vältä liian pitkiä rivejä, käytä välirivejä ja käytä välilyöntejä riveillä. Käytä vakioita. 14.2

3 Nimeä järkevästi Tunnusten (nimien) tulee olla järkeviä. Nimestä tulisi voida päätellä muuttujan tehtävä ohjelmassa ja muuttujan sisältämän tiedon luonne. Usein hyvä 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. Esimerkiksi: double keskiarvo; Luokkien nimet alkavat isolla kirjaimella. Esimerkiksi: public class HelloWorld { Vakiot kirjoitetaan isoin kirjaimin. Esimerkiksi: final char EROTIN = / ; 14.3

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. /* * Muutetaan suomenkielinen viesti morsekoodiksi ja päinvastoin. * * Lausekielinen ohjelmointi I, Jorma Laurikkala, jorma.laurikkala@uta.fi. * * Viimeksi muutettu :11:45. * */ public class Morse { 14.4

5 Sisennä Sisennys auttaa hahmottamaan kokonaisuuksia. Sisennyksellä osoitetaan lauseiden looginen ja kieliopillinen yhteenkuuluvuus. Välilyönnein tai tabulaattorilla: Kukin sisennyksen taso ainakin kaksi 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. 14.5

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ä. Esimerkiksi: while (jatketaan) { // Tulostetaan System.out.println( ); // Päivitetään lippumuuttuja. if ( ) { jatketaan = false; else jatketaan = true; 14.6

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. Esimerkki: if (valinta == LISAA) { // Lisätään.... else if (valinta == HAE) { // Haetaan else { // Virhe

8 Rivitys Osoita lauseiden looginen yhteenkuuluvuus kootun lauseen sisällä välirivejä käyttämällä. // Erota teemoja 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( ); 14.8

9 Rivitys Pitkät rivit ovat vaikeaselkoisia ja näkyvät vain osin pienessä ikkunassa. Jaa liian pitkä rivi kahdeksi lauseeksi kahdelle riville tai katkaise rivi, jolloin yksi lause on kahdella rivillä. Riviä ei saa katkaista arvon tai tunnuksen keskeltä. Yli 100 merkin mittaiset rivit alkavat olla liian pitkiä. Paranna yksittäisten rivien luettavuutta käyttämällä välilyöntejä. Esimerkiksi lause int i=(j+1)*2; on luettavampi muodossa int i = (j + 1) * 2; 14.9

10 Käytä vakioita Vakioiden tunnus kirjoitetaan ISOIN KIRJAIMIN. Esimerkki: final String LOPPU = "Ohjelma lopetettu."; 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