Re: Kuntoutettavan sovelluksen luokkadokumentit.

Kirjoittajan mukaan: Outa Valkama <outa.j.valkama_at_student.jyu.fi_at_localhost>
Päiväyksen mukaan: Mon, 21 May 2012 13:46:59 +0300
Hei,

Käyn tuon läpi vaikka tänään ja jos en kaikkea ehdi tänään käydä niin
viimeistään huomenna. Mainitsin jo aamulla tiimille, että yksinkertaisesti
unohdin käydä lähdekoodin vielä viikonlopulla läpi vaikka lupasin, mutta
käyn sen läpi myös tässä tänään. Sovellusraportista oli ilmeisesti tulossa
piakkoin uusi versio niin en käy sitä ihan vielä läpi.

Terveisin Outa Valkama

2012/5/21 Jukka-Pekka Santanen <jukka-pekka.santanen_at_mit.jyu.fi>

> Terve!
>
> Ohjaan kuntoutettavan sovelluksen luokkadokumentteja koskevan
> hyväksymisen tiedoksi myös tilaajan edustajille. Voisiko Outa
> käydä pikaisesti myös luokkadokumentit läpi?
>
> > From: Lauri Satokangas <lauri.n.satokangas_at_student.jyu.fi>
> > Date: Tue, 15 May 2012 20:24:23 +0300
> > Subject: Re: [paatti] Huomioni tapahtumien hallintanakymasta jatkuvat.
> > To: paatti_opetus_at_korppi.jyu.fi
> >
> > Kuntoutettavan käyttöliittymän JavaDoc:it löytyvät nyt osoitteesta:
> > http://sovellusprojektit.it.jyu.fi/paatti/luokkadokumentit/html/mobile/
> >
> Kuntoutettavan luokkadokumentit on osaltani hyväksytty. Voisiko
> ryhmä tarkistaa sekä korjata tai kuitata seuraavat mahdolliset
> pikkuvirheet:
>  - Onko sovelluksen versionumero 0.0.5 (TITLE), joka siis
>    viittaa projektiryhmän ulkopuolelle julkistamattomaan
>    versioon? Oletteko ajatelleet hyväksytyn version numeroksi
>    1.0.0 vai alempaa?
>  - Sovellukselle olisi mukava saada nimi, sillä TITLE viittaa
>    projektin nimeen Paatti.
>  - Osassa luokkadokumenteista on päivämäärä ja osassa ei.
>  - Pystyisikö luokan ClassEvent attribuutin EVENT_MIDDLE
>    kuvausta yksikäsitteistämään? Mitä tarkoittaa ''middle
>    of the event''?
>  - Luokkien EventViewLogic ja MobileViewHandler kuvauksissa
>    kohta ''Method Summary'' ei sovi sivulle sivusuunnassa.
>  - Luokan MenuView metodin getViewHandler kuvaus uupuu.
>  - Luokkien PaattiApplication ja PaattiApplicationServlet
>    metodien kuvaukset uupuvat.
>  - Luokan TaskChoiceChangeEventListener metodin taskChange
>    kuvauksesta käsittääkseni uupuu joitain ymmärtämistä
>    tukevia sanoja.
>  - Pitäisikö kunkin paketin tarkoitus myös kuvata?
>
> Kirjoitusasua koskevat yleiset huomioni ovat seuraavat:
>  - Muutaman metodin kuvauksessa ilmaukset ''What will be
>    done when..'' voisi vaihtaa sujuvammiksi, kuten vaikkapa
>    ''Carries out the actions related to the button push...''.
>  - Kuvauksissa tulisi mielellään käyttää yksikön kolmatta
>    persoonaa, ts. gets mieluummin kuin get.
>  - Luokan DiaryView metodin clearDiaryText ensimmäisessä
>    sanassa on kirjoitusvirhe.
>  - Joistakin kuvauksista tulisi sujuvampia käyttämällä
>    of-genetiiviä.
>  - UI kannattaa kirjoittaa isoin kirjaimin.
> Kirjoitusasua koskevat huomioni on tarkoitettu lähinnä
> palautteeksi.
>
> Luokkadokumentit ovat mielestäni sisällöltään ja kirjoitusasultaan
> mallikkaita, joten lähdekoodeihin kirjatut kommentit on laadittu
> ajatuksella. Kirjasin paperikappaleisiin joitain yksittäisiä
> pieniä huomioita lähinnä palautteeksi. Niistä kannattaa huomioida
> korkeintaan selkeiksi virheiksi katsomanne. Paperikappaleeseen
> kirjaamani huomiot palautan projektihuoneeseen parin tunnin
> sisällä.
>
> > PaattiResearch:in ja muiden projektien luokkadokumentit siirretään
> > verkkoon, kun projektien kehitys ja korjaukset saadaan päätökseen.
> >
> Pyydättehän ohjaajia tarkistamaan kyseiset luokkadokumentit
> lähettämällä asiasta sähköpostia.
>
> > PS. Tutkijan käyttöliitymällä ei vielä pysty luomaan vapaaehtoisia
> > harjoitteita, mutta toiminnon toteuttaminen ei ole vaikeaa ja
> > tullaan vielä toteuttamaan tässä projektissa.
> >
> Oletteko tämän jo toteuttaneet? Mielestäni pieniäkään puuttuvia
> ominaisuuksia ei kannata alkaa kiireessä toteuttamaan, vaan
> kirjata mieluummin niihin liittyen jatkokehittäjille ohjeet
> sovellusraporttiin.
>
> Terveisin,
>               jukka-pekka
>
> --
> #  Jukka-Pekka Santanen (PhD, Mr)    #  santanen_at_mit.jyu.fi
> #  Department of Mathematical        #  http://www.mit.jyu.fi/santanen/
> #  Information Technology            #
> #  University of Jyvaskyla           #  Room: Agora AgC418.2
> #  P.O. Box 35 (Agora)               #  Phone: +358- (0)40 8053299
> #  FIN-40014 University of Jyvaskyla #
>
>
Received on 21.05.12 13:46:59

Tämän arkiston loi hypermail 2.2.0 : 21.05.12 13:47:08 EEST