geffe / otm-harjoitustyo

Enzyme-finder

Sovellus on tarkoitettu DNA-sekvenssien analysointiin ja ohjelmalla pystyy etsimään annetusta sekvenssistä yleisimpien restriktioentsyymien katkaisukohdat.

Dokumentaatio

Käyttöohje

Vaatimusmäärittely

Arkkitehtuurikuvaus

Testausdokumentti

Työaikakirjanpito

Releaset

palautus

Komentorivitoiminnot

Testaus

Testit suoritetaan komennolla

mvn test

Testikattavuusraportti luodaan komennolla

mvn test jacoco:report

Kattavuusraporttia voi tarkastella avaamalla selaimella tiedosto target/site/jacoco/index.html

Suoritettavan jarin generointi

Komento

mvn package

generoi hakemistoon target suoritettavan jar-tiedoston Enzyme-finder-1.0-SNAPSHOT.jar

Javadoc

JavaDoc generoidaan komennolla

mvn javadoc:javadoc

JavaDocia voi tarkastella avaamalla selaimella tiedosto target/site/apidocs/index.html

Checkstyle

Tiedostoon checkstyle.xml määrittelemät tarkistukset suoritetaan komennolla

 mvn jxr:jxr checkstyle:checkstyle

Mahdolliset virheilmoitukset selviävät avaamalla selaimella tiedosto target/site/checkstyle.html

otm-harjoitustyo's Issues

Koodikatselmointi

Projekti ladattu 3.5.2018 klo 20.47

Luokat, metodit, attribuutit jne. on selkeästi nimetty ja metodien nimissä käytetään camelCase-kirjoitusasua.

Koodi on kokonaisuudessaan selkeää ja helposti luettavaa, eivätkä metodit ole liian pitkiä.

Ilmeisesti käyttöliittymään liittyviä luokkia ja metodeja löytyy tällä hetkellä sekä application- että ui-pakkauksista eikä sovelluslogiikka vaikuttaisi olevan täysin eriytetty käyttöliittymästä.

Testejä on kohtuullisesti ja kaikki menevät läpi. Testeihin on kuitenkin jäänyt muutama sekakielinen metodin nimi (toStringToimii ja searchNameToimii). Lisäksi osa testeistä on nimetty identtisiksi testikohteena olevien metodien kanssa, eli nimissä kannattaa ehkä vielä avata tarkemmin mitä metodin toiminnallisuutta testit koskevat.

Ohjelman idea kokonaisuudessaan vaikuttaa hyvältä ja käyttäjälle hyödylliseltä. Määrittelydokumentista käy hyvin ilmi se, miltä lopullisen ohjelman on tarkoitus näyttää ja kuinka sen on tarkoitus toimia.