Lähdekoodin dokumentointi ja Web-kehityksessä käytettävät tekniikat

Abstract

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.

The purpose of this thesis is to give an overview of the web development techniques and tools used for software source documentation. Special attention is paid to the Google Web Toolkit -framework and the Javadoc tool and its comment syntax specification.

Documenting the source code of the Notta for Home Control Center is used as a case study in this thesis. The documentation of the source was done by the specification of Javadoc doc comments.

This thesis is aimed at anyone who is interested in technologies used in web development. The reader will get basic knowledge of the history of web technologies and their usage. In addition the reader will get basic knowledge of the possibilities of Google Web Toolkit and its usage within the NetBeans integrated development environment. A starting point for using the Javadoc tool is also given.