Lähdekoodin dokumentointi ja Web-kehityksessä käytettävät tekniikat
Pajunen, Jani (2009)
Pajunen, Jani
Seinäjoen ammattikorkeakoulu
2009
All rights reserved
Julkaisun pysyvä osoite on
https://urn.fi/URN:NBN:fi:amk-200912057129
https://urn.fi/URN:NBN:fi:amk-200912057129
Tiivistelmä
Tämän opinnäytetyön tarkoituksena on esitellä yleisesti web-sovelluskehityksessä käytettäviä tekniikoita, sekä ohjelmistojen lähdekoodin dokumentointia ja lähdekoodin dokumentoinnissa käytettäviä työkaluja. Erityistä huomiota kiinnitetään Google Web Toolkit -sovelluskehykseen ja Javadoc-työkalun määritelmien mukaiseen lähdekoodin dokumentointiin.
Opinnäytetyössä on tapaustutkimuksena Notta for Home -kodinohjausjärjestelmän Valvomo-sovelluksen dokumentointiprojekti. Projektissa toteutettiin sovelluksen lähdekoodin dokumentointi Javadoc-työkalun määritelmien mukaisten dokumenttikommenttien avulla.
Opinnäytetyö on suunnattu kaikille, jotka ovat kiinnostuneita Web-kehityksessä käytettävistä tekniikoista. Työn lukija saa perustiedot eri tekniikoiden historiasta ja niiden käyttötarkoituksesta. Lisäksi lukija pääsee perehtymään Google Web Toolkit -ohjelmistokehyksen mahdollisuuksiin ja sovelluskehyksen käyttöön NetBeans-kehitysympäristön yhteydessä. Lukija saa myös lähtökohdan Javadoc-työkalun käyttöön.
Opinnäytetyössä on tapaustutkimuksena Notta for Home -kodinohjausjärjestelmän Valvomo-sovelluksen dokumentointiprojekti. Projektissa toteutettiin sovelluksen lähdekoodin dokumentointi Javadoc-työkalun määritelmien mukaisten dokumenttikommenttien avulla.
Opinnäytetyö on suunnattu kaikille, jotka ovat kiinnostuneita Web-kehityksessä käytettävistä tekniikoista. Työn lukija saa perustiedot eri tekniikoiden historiasta ja niiden käyttötarkoituksesta. Lisäksi lukija pääsee perehtymään Google Web Toolkit -ohjelmistokehyksen mahdollisuuksiin ja sovelluskehyksen käyttöön NetBeans-kehitysympäristön yhteydessä. Lukija saa myös lähtökohdan Javadoc-työkalun käyttöön.