Changes between Initial Version and Version 1 of Halyri/Koodinkatselmointi1Muistio


Ignore:
Timestamp:
2014-06-10 18:13:07 (5 years ago)
Author:
iltaraut
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Halyri/Koodinkatselmointi1Muistio

    v1 v1  
     1Hälyri-sovellusprojektin 1. koodinkatselmoinnin muistio 
     2 
     3Paikka: Tietotekniikan projektien kokoushuone, Agora AgC226.1 \\ 
     4Aika: Torstai 2.4.2014 klo 8.15–10.30 
     5 
     6Läsnä \\ 
     7Projektiryhmä 
     8- Niko Mononen 
     9- Veli-Mikko Puupponen, sihteeri 
     10- Ilkka Rautiainen, sihteeri 
     11- Atte Söderlund 
     12Tietotekniikan laitoksen edustajat 
     13- Vesa Lappalainen 
     14Ohjaajat 
     15- Jukka-Pekka Santanen (vastaava ohjaaja) 
     16- Jaakko Kosonen (tekninen ohjaaja) 
     17 
     18Muistio 
     19 
     20Laadittu: 2.4.2013 
     21 
     22 
     231. Hätäkeskusohjelma 
     24Kosonen ehdotti ottamaan huomioon seuraavat asiat: 
     25-       Menu-elementeille voisi laittaa tagit, jotta päästään eroon turhista switch–case-rakenteista. 
     26-       Onko helppo lokalisointi huomioitu? Joissain kohdissa päivitetään muun muassa painikkeiden tekstejä koodissa. 
     27-       Kommenttien param-kohtiin tulisi laittaa aina jotakin, vaikka asia olisi triviaali. 
     28-       Asetusmuutosten käsittelyä voisi parantaa muuttamalla indeksit enumeiksi. Tällä saadaan switch–case-rakenteita pois. 
     29-       Muuttujan nimien on oltava pidempiä ja kuvaavampia kuin yksi kirjain. 
     30-       Enumit ovat luokkia, joten ne on aloitettava isolla alkukirjaimella. 
     31-       Muuttujien nimeämisessä on käytettävä yhtenäistä tyyliä. Nyt jotkin noudattavat PascalCasea ja toiset camelCasea. 
     32 
     33Santanen: 
     34-       Luokkakommentteja puuttuu monista tiedostoista.  
     35-       Rivit ovat osin liian pitkiä erityisesti tulostusta ajatellen. 
     36-       Voisivatko tehtävien värikoodit olla valittavissa asetuksista? 
     37 
     38Lappalainen: 
     39-       Koodissa on mainittava tekijän nimi sekä myös jonkinlainen viittaus käytettyyn lisenssiin. 
     40-       Pitäisi tarkistaa onko lisenssitiedostoon tai lisenssiin viittaamiseen olemassa kommenttitagi. 
     41-       This-viitteen käyttö koodissa on sallittua, mutta käytön tulee olla yhtenäistä. 
     42-       Onko Assignment-luokka järkevää periä ListBoxItemistä? Assignment sisältää nyt myös esimerkiksi karttamerkin asetuksia, joten parempi ratkaisu saattaisi olla jonkinlainen kooste. 
     43 
     44 
     452. Älypuhelinsovellus 
     46 
     47Kosonen: 
     48-       Luokkakommentteja puuttuu monista tiedostoista.  
     49-       Palvelinpuolen asetukset eivät kuulu MainPage-sivulle. 
     50-       MakeAppNaR-metodin nimeä tulisi muuttaa kuvaavammaksi. 
     51-       Pitkän if-lauseen voisi jakaa eri riveille esim. &&-kohdissa. 
     52-       Useiden elementtien sijainti- ja kokoasetukset voidaan parhaiten määritellä xaml-sivuilla. 
     53-       Yksi mahdollinen tapa näyttää videokuvaa on täyttää koko näyttö sillä. Tämän jälkeen videokuvan päälle voi lisätä tarpeelliset ja osittain läpinäkyvät elementit, kuten kartan. 
     54-       Lähdekoodin tiedostonimet tulisi nimetä niin, että niistä voi päätellä suoraan liittyykö koodi esim. käyttöliittymään vai johonkin muuhun. 
     55-       Asetusmuutosten käsittelyä voisi parantaa muuttamalla kirjasinten kokovalinnat enumeiksi. Tällä saadaan switch–case-rakenteita pois. 
     56 
     57Santanen: 
     58-       CantMakeNoise ja CanMakeNoise sekoittuvat helposti. 
     59 
     60Lappalainen: 
     61-       MainPage-sivun ApplicationBarIconButtons_Click-metodin ei tarvita if–else-rakennetta. 
     62-       Asetusten tallentamisessa käytetään turhan paljon merkkijonoja. 
     63-       Koodin rivijaot tulisi yhdenmukaistaa. 
     64-       Kartassa ja muissa elementeissä on käytetty koodin seassa määriteltyjä kokomäärityksiä. Nämä tulisi suhteuttaa laitteen näytön ominaisuuksiin ja määritellä yhdessä paikassa. 
     65-       Kartan tarkennus säilyy useissa älypuhelinsovelluksissa samalla tasolla seuraavalla käynnistyskerralla, vaikka näkymästä poistuisikin. Toisaalta Lappalainen tarkensi, että sovellus on luonteeltaan erityistapaus, joten tarkennustason säilyminen ei välttämättä ole olennaista. 
     66-       Kartan pienennyksen ja suurennuksen voisi hoitaa ilman if–else-rakennetta. 
     67-       Muualta löydetyistä innovatiivisista esimerkkikoodeista voi lähdekoodissa mainita lähteen, mutta löydetyssä ”peruskoodissa” se ei ole tarpeen. 
     68 
     693. Palvelin 
     70 
     71Kosonen: 
     72-       AutoMappereiden asetukset voisi sijoittaa erilliseen luokkaan. 
     73 
     74Lappalainen: 
     75-       Voisiko GUID:n siirtää UID:nä merkkijonon sijaan, ainakin sisäisessä käsittelyssä? 
     76-       Koodin tiivistäminen yleistämällä on mahdollista ainakin ConnectionController-luokassa, mahdollisesti myös muualla.