Lähdekoodin kommentointi

Abstract

Tässä tutkielmassa selvitetään, miten alan kirjallisuudessa lähestytään lähdekoodin kommentointia. Tutkielman tavoite on tuoda esille hyviksi todettuja tapoja kommentoida lähdekoodia. Lisäksi tarkastellaan erilaisia normeja ja yleisiä käytänteitä liittyen lähdekoodin kommentointiin. Lopputulemana lukijalle on selvää, kenen vastuulla on kommentoida koodia, miten koodia tulisi kommentoida ja milloin. Lisäksi lukijalle tulee selväksi minkälaisia työkaluja systemaattiseen ja laadukkaaseen kommentointiin on tarjolla.

This study takes a look at how source code commenting is seen in the literature in the field of IT. The aim of this study is to bring up the best practices doing source code commenting. In addition, the study takes a look at different kinds of norms and common practices related to source code commenting. The end result is to have an in-depth view who is in charge of code commenting, how and when you should comment, and which kind of tools you can use to get systematic and quality source code comments.