Giter Site home page Giter Site logo

okulfrekvenssi's Introduction

okulfrekvenssi's People

Contributors

falzed avatar

Watchers

James Cloos avatar  avatar

okulfrekvenssi's Issues

Vertausarviointi

Projekti ladattu noin 20:30, 7.12.2018

Dokumentointi

Dokumentoinnissa on jonkin verran ongelmia, esim se että käytettyjä Ceasar ja Vigenére-cyphereita ei selitä paljon yhtään. Jouduin opiskelemaan ne käytännössä itse nollasta jotta pystyn tutkimaan koodia millään tarkemmalla tasolla. Toinen ongelma dokumentaatiossa on, että siinä ei kerrota itse ohjelman rakenteesta mitään. Siellä todetaan minkälainen käyttöliittymä on ja mitä puutteita ohjelmalla on, mutta siinä ei kerrota mitään mitä mitkäkin luokat sisältävät ja miten ne toimivat muiden osien kanssa.

Koodin laatu

Koodissa on jonkin verran toistoa jonka saa helposti pois. Esim Analysis-luokassa on luotu char-array suomalaisille aakkosille, vaikka sellainen löytyy jos util.Alphabet -luokasta. CaesarAnalysis -luokassa luodaan Caesar muuttuja, mutta sille ei tehdä mitään.

Toinen suhteellisen helposti korjattava ongelma koodissa on pitkät metodit. Monet metodeista ovat turhan monimutkaisia, ja pitkiä. Esim Analysis-luokassa metodi normalizedFrequencies koostuu kolmesta for-loopista, joista en ainakaan itse henkilökohtaisesti saa päätä enkä häntää. Jos ne jaetaan omiin pienempiin metodeihin hyvillä nimillä, tekisi se koodista luettavampaa.

Tämän lisäksi vielä kannattaisi yrittää pienentää luokkien kokoa jakamalla niiden toimintoa pienempiin kokonaisuuksiin. Main.java esim on todella iso, ja se olisi mahdollista jakaa pienempiin luokkiin jotka suorittaisivat eri komentoja. Tämä on tietenkin tämän kurssin aiheiden ulkopuolella, mutta se auttaisi koodin tutkimista.

Kun ohjelman käynnistää niin varmaan myös kannattaisi printata joitain komentoja joita käyttäjä voi syöttää, tällä hetkellä ohjelman käyttäminen ilman lähdekoodia olisi mahdotonta.

Ohjelma toimii kuitenkin halutulla tavalla, enkä itse pystyisi tehdä samanlaista ohjelmaa ilman että käyttäisin todella paljon aikaa.

Tässä oli kaikki negatiiviset maininnat mitä löysin/keksin puolessatoista tunnissa, kaikki asiat mitä en maininnut oltiin tehty omasta mielestä moitteettomasti, ja projektista huomaa että kyseessä on mielenkiinnon kohde.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.