OHJEITA C-OHJELMOINNIN HARJOITUSTYÖTÄ VARTEN (Syksy 2006)

YLEISTÄ

TYÖN ALOITUS JA TYÖNOHJAUSTILAISUUDET

Työnohjaustilaisuuksia järjestetään kaksi kertaa. Ohjausta antaa Timo Tuominen ke 11.10 klo 12-16 salissa CK110 sekä ke 1.11 klo 12-16 salissa CK110.

Voit tehdä työsi millä tahansa koneella, mutta tuloksen on kuitenkin ehdottomasti toimittava myös laitoksen Linux-koneilla (muista siis siirrettävyys).

Kaikissa harjoitustöissä on käytettävä jotain linkitettyä rakennetta, tiedostosta lukemista ja kirjoittamista sekä komentoriviparametreja. Muita ominaisuuksia voi sitten käyttää tarpeen mukaan.

Muutama opiskelija on pyytänyt vähän lisäaikaa harjoitustyöhön, joten tasapuolisuuden vuoksi tiedoksi kaikille: harjoitustyö on ajoissa palautettu, jos sen palauttaa viimeistään maanataiaamuuna 6.11 klo 9 mennessä.
1. Yksinkertainen laskin, 3. Kaupan kassan simulointi ja 6. Ravintolan simulointi palautetaan Timo Tuomiselle (Timo.Tuominen@helsinki.fi) ja
muut työt Päivi Kuuppelomäelle (Paivi.Kuuppelomaki@cs.helsinki.fi).
Vastuu sopivasta aikataulusta on sinulla itselläsi.

HYVIN SUUNNITELTU PUOLIKSI TEHTY

POIS TURHA HIENOSTELU: Eli tee se ja vain se mitä pyydetään ja tee lisävirittelysi vain omaan versioosi!

Sopiva ohjelman pituus on 200-500 riviä koodia (plus kommentit). Pituutta tärkeämpää on kuitenkin, että ohjelma tekee mitä pyydetään.

Älä aliarvioi suunnittelun merkitystä toimintapainotteisessakaan lähestymistavassa.

HYVÄT OHJELMAT EIVÄT KASVA ITSESTÄÄN - NE TEHDÄÄN

• Ensimmäinen mieleentuleva ratkaisu ei ole välttämättä paras.
• Huonoon ratkaisuun ei saa investoida liikaa liian aikaisin.
• Hyvä ohjelma toimii oikein, tehokkuus on usein vähemmän tärkeää.

Laadi aina erillinen pääohjelma ja sijoita yhteenkuuluvat, jonkin selkeän osatehtävän suorittavat funktiot omiin lähdekooditiedostoihinsa

Tee työsi hyvällä maulla (AINA):

• yhtenäinen ohjelmointityyli
• vältä kielen erikoisuuksia ja kryptistä koodia
• iskunkestävä ohjelma - ei natise, eikä kaadu
• pieni opastus mukaan
• muuttujat: kuvaavat nimet, joista selviää käyttötarkoitus merkitys ja käyttö huomioonottaen

DOKUMENTOINTI: TARPEELLINEN OSA

Ohjelman kommentoinnissa pätevät seuraavat yksinkertaiset säännöt:

• Kukin ohjelmatiedosto sisältää yleiskommentin:
• Mihin tiedosto on tarkoitettu
• Mitä funktioita tiedosto sisältää
• Mitä muiden tiedostojen funktioita tiedosto käyttää
• Käytettyjä kirjastofunktioita ei tarvitse listata
• Selvitä tärkeät tietorakenteet.
• Kerro kustakin funktiosta:
• Mitä funktio tekee
• Mitkä ovat parametrit
• Mitä funktio palauttaa
• Mitä funktio muuttaa
• Varo liiallista kommentointia. Käytä selkeitä muuttujanimiä, kielen rakenteet oletetaan tunnetuksi jne.
• Kommentoi vaikeat ja erikoiset ratkaisut

HARJOITUSTYÖN PALAUTUS: MITENKÄS SE MENIKÄÄN?

Työ on jätettävä tarkastettavaksi viimeistään ma 6.11. klo 9. Työt jätetään tarkastettavaksi sähköpostitse.

Tarkastettavaksi jätetään yksi tar-tiedosto, johon on koottu kaikki työhön liittyvä materiaali:

• kaikki harjoitustyön C-kieliset ohjelmatiedostot,
• niiden kääntämisen toteuttava Makefile-tiedosto
• readme- tai ohje-niminen tiedosto, joka sisältää työn dokumentoinnin

Tarkastajalle lähetetään sähköpostitse vain linkki talletettuun tar-tiedostoon.

HARJOITUSTYÖN ARVOSTELUSTA

Työn arvostelussa otetaan huomioon seuraavat asiat:

• ohjelman laajuus ja vaikeus, (1-2 p) (Älä tee turhan laajaa!)
  • 1 p toteuttaa annetun tehtävän kohtalaisesti
  • 2 p toteuttaa annetun erittäin hyvin
• käytetty ratkaisuperiaate ('Tämän miettimiseen kannattaa käyttää hieman aikaa.') (1- 2 p)
  • selkeä, järkevä, toimiva tietorakenneratkaisu
  • mielekäs jako käynnistysyksiköiksi
• ohjelmanrakenne eli ohjelman jako funktioihin, C-piirteiden järkevä, tehokas käyttö (1-3 p)
  • ohjelman jako funktioihin (0-1 p)
  • C-piirteiden käyttö (0-2) (järkevyys, tehokkuus) ja yleensä hyvä ohjelmointityyli
• ohjelman ulkonäkö ja luettavuus (kommentointi, muuttujien nimet, sisennykset, yhtenäisyys) (0-1 p)
• ohjelman testaus ja testitilanteet (0-1 p)
• käyttöohje (1 p)

Ohjelma palautetaan korjattavaksi, jos

1. ohjelma ei käänny
2. ohjelma toiminta katkeaa vakavaan suoritusaikaiseen virheeseen
3. ohjelma ei lainkaan suorita sitä, mitä sen pitäisi tehdä
4. dokumentointi puuttuu kokonaan
5. ohjelman testikuvaus puuttuu kokonaan
6. ohjelmassa ei ole lainkaan funktioita
7. ohjelman arvostelussa sen yhteispistemäärä on pienempi kuin 3. (Harjoitustyöstä vaaditaan 3 pistettä kurssin läpipääsyyn.)
8. Ohjelmasta puuttuu jokin vaadittu piirre: listarakenne, tiedostoston käsittely tai komentoriviparametrin käyttö.

Palaute harjoitustyöstä annetaan normaalisti sähköpostitse, tarvittaessa voidaan myös käyttää tapaamista ja suullista palautetta, etenkin, jos lisäohjaus on tarpeen.
Tarkastukseen jätetty C-harjoitustyö annetaan korjattavaksi korkeintaan yhden kerran. Korjausaikaa on 1-2 viikkoa. Korjauksen jälkeen työ joko hyväksytään tai lopullisesti hylätään. Jos työ joudutaan hylkäämään, niin myös kokeessa saadut pisteet mitätöityvät.

Onnea työlle!