Harjoitustyön teko-ohje

<BODY ><a name="_Toc18802658"></a><A NAME="Heading1"></A><H1 ALIGN="LEFT"> Harjoitustyön tekeminen </H1> <P ALIGN="LEFT"></P><P ALIGN="LEFT"></P> <HR><a name="_Toc18802659"></a><A NAME="Heading2"></A><H2 ALIGN="LEFT"> 1. Harjoitustyön aihe ja sisältö </H2> <P ALIGN="LEFT">Tärkein asia tässä harjoitustyössä on käyttöliittymän komponenttien käyttö. Erityisesti omien komponenttien tuottaminen ja jakaminen muiden käyttöön. Algoritmiset seikat eivät ole niin suurella painolla. <a name="_Toc18802660"></a></P> <A NAME="Heading3"></A><H3 ALIGN="LEFT"> 1.1 Aihe</H3> <P ALIGN="LEFT">Harjoitustyön aihe pitää keksiä itse. Se voi olla esimerkiksi jonkin aikaisemmin tehdyn ohjelman käyttöliittymän muuttaminen graafiseksi (vaikkapa Ohjelmointikurssin harjoitustyö, tosin tämä on ehkä työlästä), jokin peli tai mikä tahansa mieleenjuolahtava (tarpeellinen) aihe. </P><P ALIGN="LEFT"></P><P ALIGN="LEFT">Aihe voi olla myös malliohjelman </P> <PRE><A HREF="http://www.mit.jyu.fi/~vesal/vlwinapp/matka02/">http://www.mit.jyu.fi/~vesal/vlwinapp/matka02/</A> </PRE><P ALIGN="LEFT">puutteellisten/tekemättömien ominaisuuksien toteuttaminen/parantaminen. </P><P ALIGN="LEFT"></P><P ALIGN="LEFT">Aiheen virikkeeksi voi käydä katsomassa vanhoja harjoitustöitä hakemistosta: <TT>N:\KURSSIT\WINOHJ\HTYOT.</TT><a name="_Toc18802661"></a></P> <A NAME="Heading4"></A><H3 ALIGN="LEFT"> 1.2 Vaaditut ominaisuudet </H3> <P ALIGN="LEFT">Harjoitustyössä pitää olla tyypilliset Windows- ominaisuudet: </P> <UL> <LI> menut<LI> <I>About-</I>dialogi<LI> avustus<LI> painonappeja, pikanäppäimiä <a name="_Toc18802662"></a></UL><A NAME="Heading5"></A><H3 ALIGN="LEFT"> 1.3 Lisäominaisuudet</H3> <P ALIGN="LEFT">Lisäksi mielellään osa seuraavista (jos aihe vain suo mahdollisuuden): </P> <UL> <LI> leikekirjan käyttö <LI> <I>DDE, OLE </I><LI> optioiden kysyminen käyttäjältä <LI> .INI - tiedoston tai rekisterin käyttö optioiden tallettamiseen <LI> käyttökielen vaihto (suomi/englanti) </UL><P ALIGN="LEFT"></P><P ALIGN="LEFT">Eli laivanupotuspeli, joka on aina 10x10 ruudussa on huono aihe, mutta jos käyttäjä voi itse valita pelilaudan koon jostakin dialogista ja menusta, niin aihe onkin jo parempi. <a name="_Toc18802663"></a></P> <A NAME="Heading6"></A><H3 ALIGN="LEFT"> 1.4 Komponentit</H3> <P ALIGN="LEFT">Jokaisen harjoitustyössä pitää valmistua vähintään yksi yleiskäyttöinen komponentti (arpakuutio, pelikortti, korttipakka, pelilauta tms...), joka luovutetaan kaikkien kurssilaisten käyttöön dokumentoituna. </P><P ALIGN="LEFT"></P><P ALIGN="LEFT">Kurssille perustetaan postilista: <A HREF="mailto:gko02k@korppi.jyu.fi">gko02k@korppi.jyu.fi</A>, jossa on aluksi tarkoitus ilmoittaa mitä komponentteja oma harjoitustyö tulee sisältämään. Sitten kaikki ne, jolla on tarvetta moiseen komponenttiin, tekevät yhdessä mailina vaativuusmäärittelyn ko. Komponentille (esim. pitääkö arpakuutiossa olla 6 sivua, vaiko mielivaltainen määrä, pitääkö kuution kuvat olla käyttäjän valittavissa jne...). </P><P ALIGN="LEFT"></P><P ALIGN="LEFT">Komponentit laitetaan WWW-sivuille sitten vapaasti levitettäväksi ja tarkoitus on että kurssilaiset käyttäisivät mahdollisuuksien mukaan myös muiden tekemiä komponentteja. </P><P ALIGN="LEFT"></P><P ALIGN="LEFT">Komponentit tehdään mieluiten <I>Delphillä</I> (koska silloin niitä voi käyttää myös <I>C++ Builderissä </I>). </P><P ALIGN="LEFT"><a name="_Toc18802664"></a></P> <A NAME="Heading7"></A><H3 ALIGN="LEFT"> 1.5 Dokumentointi</H3> <P ALIGN="LEFT">Harjoitustyöksi palautetaan dokumentoitu ohjelmalistaus. Osa dokumentointia on ongelman jakaminen selkeiksi ja hyvin nimetyiksi aliohjelmiksi. Samoin osa dokumentointia on epämääräisten vakioiden siirtäminen koodista tiedoston alussa oleviin vakiolausekkeisiin. <a name="_Toc18802665"></a></P> <A NAME="Heading8"></A><H3 ALIGN="LEFT"> 1.6 Turvallisuus</H3> <P ALIGN="LEFT">Ohjelma on tehtävä siten, että vaikka siinä käytetään osoittimia, ei niillä osoiteta oman alueen ylitse (esim. c: <TT>strcpy</TT> jne. on käytettävä erittäin harkitusti). Samoin vaikka ohjelma "toimisikin", saattaa se varata resursseja joita se ei vapauta ja näin ohjelman käynnistäminen useaan kertaan johtaa koko Windowsin tukkeutumiseen. Eli kaikki mitä varataan, pitää myös vapauttaa. <a name="_Toc18802666"></a></P> <A NAME="Heading9"></A><H3 ALIGN="LEFT"> 1.7 Jukisuus ja tekijänoikeus </H3> <P ALIGN="LEFT">Keskeneräiset ja valmiit harjoitustyöt ovat nähtävillä WWW:ssä myöhemmin esitettävällä tavalla. Tekijänoikeus on ilman muuta silti tekijällä ja hän voi muotoilla lähdekoodiinsa haluamansa tekijänoikeudet (esim. GPL). </P><P ALIGN="LEFT"><a name="_Toc18802667"></a></P> <A NAME="Heading10"></A><H2 ALIGN="LEFT"> 2. Työkalut<a name="_Toc18802668"></a></H2> <A NAME="Heading11"></A><H3 ALIGN="LEFT"> 2.1 Delphi, C++ - kieli tai Java </H3> <P ALIGN="LEFT">Pääsääntöisesti jokainen tekee harjoitustyönsä <I>Delphillä</I> tai <I>Kylixillä</I> (äärimmäisessä hätätilassa joko <I>C++ Builderillä </I> tai <I>Javalla</I>).</P><P ALIGN="LEFT"></P><P ALIGN="LEFT">Viestin käsittelynä voidaan käytetään <I>Borlandin VCL </I>:ää tai <I>CLX</I>:ää. Mieluiten niin, että <TT>ifdef</TT>-lauseilla mahdollistetaan kumpi tahansa käännös. </P><P ALIGN="LEFT"></P><P ALIGN="LEFT">Ohjelma pitää kääntämään ainakin 32-bittistä Windowsia varten. Samoin ohjelman käännöksessä EI SAA tulla yhtään virhettä eikä varoitusta. <a name="_Toc18802669"></a></P> <A NAME="Heading12"></A><H3 ALIGN="LEFT"> 2.2 Aliohjelmakirjastot ja komponentit </H3> <P ALIGN="LEFT">Kurssilla jaetaan varsin suuri määrä aliohjelmia ja komponentteja eri tilanteiden käsittelyyn. Näitä saa vapaasta jokainen käyttää hyväkseen. </P><P ALIGN="LEFT"></P><P ALIGN="LEFT">Toisaalta omaan harjoitustyöhön saattaa tulla hienoja ominaisuuksia, jotka hieman modifioimalla kelpaisivat muillekin. Kaikki nämä pitää kirjoittaa omaksi komponenttikokoelmakseen ja dokumentoida siten, että muutkin voivat niitä käyttää. Hyvät komponentit liitetään sitten kurssin julkiseen aliohjelmahakemistoon. <a name="_Toc18802670"></a></P> <A NAME="Heading13"></A><H3 ALIGN="LEFT"> 2.3 Java ja Delphi </H3> <P ALIGN="LEFT">Jokainen tekee ohjelmastaan myös rinnakkaisen "pikkuversion" (vain muutamia ominaisuuksia tai pelkkä runko) kaikilla otsikossa mainituilla työvälineillä. <I>Visual Basic </I>sta voi ostaa itseopiskelupaketin ja luennolla sitä käsitellään tunnin verran myöhemmin syksyllä. Jos itse työ on tehty <I>Delphillä</I>, silloin <I>Delphi-</I>versiota ei tietysti tarvitse tehdä uudestaan. </P><P ALIGN="LEFT"></P><P ALIGN="LEFT">Tavoitteena on että jokainen ainakin pienessä määrin tutustuu yleisimpiin työkaluihin ja erityisesti niiden tapahtuman käsittelyyn. Näiden pikaversioiden toteuttamiseen on tarkoitus käyttää esim. Javalla max 1-2 h (ulkoasu oikean oloinen, kaikista napeista tulee "Ei toimi"-dialogi, About-dialogi toimii, ohjelmasta pääsee pois). Nämä "lisäversiot" kannattaa tehdä heti kun asia on pääteohjauksissa ja luennoilla käsitelty. <a name="_Toc18802671"></a></P> <A NAME="Heading14"></A><H2 ALIGN="LEFT"> 3. Aikataulu = TARJOUS <a name="_Toc18802672"></a></H2> <A NAME="Heading15"></A><H3 ALIGN="LEFT"> 3.1 Sisältö</H3> <P ALIGN="LEFT">Koska erityinen toivomus opiskelusta työelämään siirtyneiltä on se, että pitäisi opettaa myös suunnittelua ja aikataulussa pysymistä, niin jokainen laatii omasta harjoitustyöstään SIISTIN HTML aikataulun, johon on kirjoitettu vähintään. </P> <UL> <LI> oma nimi <LI> lyhyt kuvaus aiheesta <LI> 5-10 kohtainen toteutusaikataulu päivämäärineen (esisuunnitelma ... runko ... avustuksen kirjoittaminen ... lopullinen versio). </UL><P ALIGN="LEFT"></P><P ALIGN="LEFT">Muuten aikataulun muoto saa olla vapaa ja siinä jokainen voi yrittää käyttää graafista silmäänsä parhaansa mukaan. Fonttikoon ei kuitenkaan tarvitse olla normaalia suurempaa, eikä fonttien kovin eksoottisia. Kuitenkin <TT>Courier</TT>- fontin käyttö (muualla kuin ohjelma listauksissa) osoittaa ettei ymmärrä tekstinkäsittelystä yhtään mitään. </P><P ALIGN="LEFT"></P><P ALIGN="LEFT">Näitä aikatauluja luetaan kuten tarjouksia, eli tarjouksen pitää olla mahdollisemmin houkutteleva, jotta asiakas "ostaa" nimenomaan tämän tuotteen lukuisten vastaavien joukosta! <a name="_Toc18802673"></a></P> <A NAME="Heading16"></A><H3 ALIGN="LEFT"> 3.2 Tarjouksen palautus </H3> <P ALIGN="LEFT">Aikataulu tallennetaan samaan paikkaan kuin <A HREF="http://www.mit.jyu.fi/~vesal/kurssit/winohj02/htnaytto.html">kurssin harjoitustyökin</A> nimelle tarjous.html. Kaikki tarjouksessa olevat kuvat yms. laitetaan samaan alihakemistorakenteeseen ja viitteen lisukkeisiin pitää olla suhteellisia. Nimi tarjous.html ja kaikki sen vaatimat lisätiedostot lisätään files.txt-tiedostoon. </P><P ALIGN="LEFT"><a name="_Toc18802674"></a></P> <A NAME="Heading17"></A><H3 ALIGN="LEFT"> 3.3 Aikataulun ja harjoitustyön arvosteleminen </H3> <P ALIGN="LEFT">Aikataulun voi olla suunniteltu jokaisen omiin tarpeisiin ja opintoihin sopivaksi, ja siinä pysyminen sekä harjoitustyö arvostellaan osana kurssia -3 - +2 pistettä. Liian löysä ja epätäsmällinen aikataulu sinänsä on jo negatiivinen ilman erittäin hyviä perusteita. <a name="_Toc18802675"></a></P> <A NAME="Heading18"></A><H3 ALIGN="LEFT"> 3.4 Aikataulu palautettava 3.10 mennessä </H3> <P ALIGN="LEFT">Harjoitustyön aihe on oltava paikallaan viimeistään torstaina 3.10. <a name="_Toc18802676"></a></P> <A NAME="Heading19"></A><H3 ALIGN="LEFT"> 3.5 Aiheen ilmoittaminen mailina ja alustava komponenttiluettelo </H3> <P ALIGN="LEFT">Heti kun postilista on saatu valmiiksi, ilmoittaa jokainen postilistalle aiheensa ja alustavan luettelon siitä, mitä komponentteja hänen työnsä tulee sisältämään. Tämän pohjalta kurssilaiset voivat sitten ruveta tarkentamaan komponenttimäärityksiä postilistan välityksellä. Samasta komponentista voi lopulta olla useitakin kilpailevia toteutuksia, kunhan komponenttien rajapinta saadaan sovittua samaksi. <a name="_Toc18802677"></a></P> <A NAME="Heading20"></A><H3 ALIGN="LEFT"> 3.6 Välivaiheiden näyttäminen </H3> <P ALIGN="LEFT">Harjoitustyö säilytetään Webissä. Tästä on erillinen ohje: </P><P ALIGN="LEFT"><A HREF="http://www.mit.jyu.fi/~vesal/kurssit/winohj02/htnaytto.html">http://www.mit.jyu.fi/~vesal/kurssit/winohj02/htnaytto.html</A> </P><P ALIGN="LEFT"></P><P ALIGN="LEFT">Välivaiheiden näytöissä ollaan mielellään henkilökohtaisesti paikalla selittämässä. <a name="_Toc18802678"></a></P> <A NAME="Heading21"></A><H3 ALIGN="LEFT"> 3.7 Ongelmista voi kysyä muulloinkin </H3> <P ALIGN="LEFT">On aivan ilmeistä, että tämän kurssin harjoitustyössä tulee erinäisiä ongelmia, joita ratkoessaan vain hakkaa päätään seinään ja meinaa vielä viivästyä aikataulusta. Kohtuullisen ongelma ratkaisuyrityksen jälkeen voi ilman muuta kääntyä aina ohjaajan puoleen, on sitä itsekin oltu vaikeuksissa (ja tullaan olemaan). </P><P ALIGN="LEFT"></P><P ALIGN="LEFT">Aluksi kysyn joka tapauksessa, että onko tilannetta tutkittu debuggerilla, joten tämä kannattaa tehdä jo etukäteen. Samoin ongelma kannattaa yrittää paimentaa hyvin pienelle alalle. Näin voimme vähän nopeuttaa ongelman käsittelyä. <a name="_Toc18802679"></a></P> <A NAME="Heading22"></A><H2 ALIGN="LEFT"> 4. Ajanvaraus</H2> <P ALIGN="LEFT">Jotta jokaisella voidaan taata kohtuullinen aika työn käsittelyyn, on parasta varata etukäteen aika. Viikoittainen varauslista on Korpissa kohdassa Ohjausajat ( <A HREF="https://korppi.it.jyu.fi/kotka/calendar/bookableTimes.jsp?coursecode=53&supervisor=4">https://korppi.it.jyu.fi/kotka/calendar/bookableTimes.jsp?coursecode=53&supervisor=4</A>) (Paikka Agora C434.2). Muistakaa perua aika jos ette jostain syystä käytäkään sitä. </P><P ALIGN="LEFT"></P><P ALIGN="LEFT">Pikakysymykset voi tehdä ilman ajanvarausta tai jopa jos saa käytävällä hihasta kiinni. </P><P ALIGN="LEFT"></P> </BODY>