Lähdekoodin kommentointi

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 lu...

Full description

Bibliographic Details
Main Author: Jallow, Musa
Other Authors: Informaatioteknologian tiedekunta, Faculty of Information Technology, Informaatioteknologia, Information Technology, Jyväskylän yliopisto, University of Jyväskylä
Format: Bachelor's thesis
Language:fin
Published: 2020
Subjects:
Online Access: https://jyx.jyu.fi/handle/123456789/71889
_version_ 1826225799620984832
author Jallow, Musa
author2 Informaatioteknologian tiedekunta Faculty of Information Technology Informaatioteknologia Information Technology Jyväskylän yliopisto University of Jyväskylä
author_facet Jallow, Musa Informaatioteknologian tiedekunta Faculty of Information Technology Informaatioteknologia Information Technology Jyväskylän yliopisto University of Jyväskylä Jallow, Musa Informaatioteknologian tiedekunta Faculty of Information Technology Informaatioteknologia Information Technology Jyväskylän yliopisto University of Jyväskylä
author_sort Jallow, Musa
datasource_str_mv jyx
description 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.
first_indexed 2020-09-28T20:00:41Z
format Kandityö
free_online_boolean 1
fullrecord [{"key": "dc.contributor.author", "value": "Jallow, Musa", "language": "", "element": "contributor", "qualifier": "author", "schema": "dc"}, {"key": "dc.date.accessioned", "value": "2020-09-28T05:34:12Z", "language": null, "element": "date", "qualifier": "accessioned", "schema": "dc"}, {"key": "dc.date.available", "value": "2020-09-28T05:34:12Z", "language": null, "element": "date", "qualifier": "available", "schema": "dc"}, {"key": "dc.date.issued", "value": "2020", "language": "", "element": "date", "qualifier": "issued", "schema": "dc"}, {"key": "dc.identifier.uri", "value": "https://jyx.jyu.fi/handle/123456789/71889", "language": null, "element": "identifier", "qualifier": "uri", "schema": "dc"}, {"key": "dc.description.abstract", "value": "T\u00e4ss\u00e4 tutkielmassa selvitet\u00e4\u00e4n, miten alan kirjallisuudessa l\u00e4hestyt\u00e4\u00e4n l\u00e4hdekoodin kommentointia. Tutkielman tavoite on tuoda esille hyviksi todettuja tapoja kommentoida l\u00e4hdekoodia. Lis\u00e4ksi tarkastellaan erilaisia normeja ja yleisi\u00e4 k\u00e4yt\u00e4nteit\u00e4 liittyen l\u00e4hdekoodin kommentointiin. Lopputulemana lukijalle on selv\u00e4\u00e4, kenen vastuulla on kommentoida koodia, miten koodia tulisi kommentoida ja milloin. Lis\u00e4ksi lukijalle tulee selv\u00e4ksi mink\u00e4laisia ty\u00f6kaluja systemaattiseen ja laadukkaaseen kommentointiin on tarjolla.", "language": "fi", "element": "description", "qualifier": "abstract", "schema": "dc"}, {"key": "dc.description.abstract", "value": "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.", "language": "en", "element": "description", "qualifier": "abstract", "schema": "dc"}, {"key": "dc.description.provenance", "value": "Submitted by Paivi Vuorio (paelvuor@jyu.fi) on 2020-09-28T05:34:12Z\nNo. of bitstreams: 0", "language": "en", "element": "description", "qualifier": "provenance", "schema": "dc"}, {"key": "dc.description.provenance", "value": "Made available in DSpace on 2020-09-28T05:34:12Z (GMT). No. of bitstreams: 0\n Previous issue date: 2020", "language": "en", "element": "description", "qualifier": "provenance", "schema": "dc"}, {"key": "dc.format.extent", "value": "30", "language": "", "element": "format", "qualifier": "extent", "schema": "dc"}, {"key": "dc.language.iso", "value": "fin", "language": null, "element": "language", "qualifier": "iso", "schema": "dc"}, {"key": "dc.rights", "value": "In Copyright", "language": "en", "element": "rights", "qualifier": null, "schema": "dc"}, {"key": "dc.subject.other", "value": "kommentointi", "language": "", "element": "subject", "qualifier": "other", "schema": "dc"}, {"key": "dc.subject.other", "value": "source code", "language": "", "element": "subject", "qualifier": "other", "schema": "dc"}, {"key": "dc.subject.other", "value": "documentation", "language": "", "element": "subject", "qualifier": "other", "schema": "dc"}, {"key": "dc.subject.other", "value": "commenting", "language": "", "element": "subject", "qualifier": "other", "schema": "dc"}, {"key": "dc.subject.other", "value": "programming", "language": "", "element": "subject", "qualifier": "other", "schema": "dc"}, {"key": "dc.title", "value": "L\u00e4hdekoodin kommentointi", "language": "", "element": "title", "qualifier": null, "schema": "dc"}, {"key": "dc.type", "value": "bachelor thesis", "language": null, "element": "type", "qualifier": null, "schema": "dc"}, {"key": "dc.identifier.urn", "value": "URN:NBN:fi:jyu-202009285964", "language": "", "element": "identifier", "qualifier": "urn", "schema": "dc"}, {"key": "dc.type.ontasot", "value": "Bachelor's thesis", "language": "en", "element": "type", "qualifier": "ontasot", "schema": "dc"}, {"key": "dc.type.ontasot", "value": "Kandidaatinty\u00f6", "language": "fi", "element": "type", "qualifier": "ontasot", "schema": "dc"}, {"key": "dc.contributor.faculty", "value": "Informaatioteknologian tiedekunta", "language": "fi", "element": "contributor", "qualifier": "faculty", "schema": "dc"}, {"key": "dc.contributor.faculty", "value": "Faculty of Information Technology", "language": "en", "element": "contributor", "qualifier": "faculty", "schema": "dc"}, {"key": "dc.contributor.department", "value": "Informaatioteknologia", "language": "fi", "element": "contributor", "qualifier": "department", "schema": "dc"}, {"key": "dc.contributor.department", "value": "Information Technology", "language": "en", "element": "contributor", "qualifier": "department", "schema": "dc"}, {"key": "dc.contributor.organization", "value": "Jyv\u00e4skyl\u00e4n yliopisto", "language": "fi", "element": "contributor", "qualifier": "organization", "schema": "dc"}, {"key": "dc.contributor.organization", "value": "University of Jyv\u00e4skyl\u00e4", "language": "en", "element": "contributor", "qualifier": "organization", "schema": "dc"}, {"key": "dc.subject.discipline", "value": "Tietotekniikka", "language": "fi", "element": "subject", "qualifier": "discipline", "schema": "dc"}, {"key": "dc.subject.discipline", "value": "Mathematical Information Technology", "language": "en", "element": "subject", "qualifier": "discipline", "schema": "dc"}, {"key": "yvv.contractresearch.funding", "value": "0", "language": "", "element": "contractresearch", "qualifier": "funding", "schema": "yvv"}, {"key": "dc.type.coar", "value": "http://purl.org/coar/resource_type/c_7a1f", "language": null, "element": "type", "qualifier": "coar", "schema": "dc"}, {"key": "dc.rights.accesslevel", "value": "openAccess", "language": null, "element": "rights", "qualifier": "accesslevel", "schema": "dc"}, {"key": "dc.type.publication", "value": "bachelorThesis", "language": null, "element": "type", "qualifier": "publication", "schema": "dc"}, {"key": "dc.subject.oppiainekoodi", "value": "602", "language": "", "element": "subject", "qualifier": "oppiainekoodi", "schema": "dc"}, {"key": "dc.subject.yso", "value": "ohjelmointi", "language": null, "element": "subject", "qualifier": "yso", "schema": "dc"}, {"key": "dc.subject.yso", "value": "dokumentointi", "language": null, "element": "subject", "qualifier": "yso", "schema": "dc"}, {"key": "dc.subject.yso", "value": "l\u00e4hdekoodit", "language": null, "element": "subject", "qualifier": "yso", "schema": "dc"}, {"key": "dc.rights.url", "value": "https://rightsstatements.org/page/InC/1.0/", "language": null, "element": "rights", "qualifier": "url", "schema": "dc"}]
id jyx.123456789_71889
language fin
last_indexed 2025-02-18T10:55:44Z
main_date 2020-01-01T00:00:00Z
main_date_str 2020
online_boolean 1
online_urls_str_mv {"url":"https:\/\/jyx.jyu.fi\/bitstreams\/08c099b1-84f0-488e-82e7-645808dd88bf\/download","text":"URN:NBN:fi:jyu-202009285964.pdf","source":"jyx","mediaType":"application\/pdf"}
publishDate 2020
record_format qdc
source_str_mv jyx
spellingShingle Jallow, Musa Lähdekoodin kommentointi kommentointi source code documentation commenting programming Tietotekniikka Mathematical Information Technology 602 ohjelmointi dokumentointi lähdekoodit
title Lähdekoodin kommentointi
title_full Lähdekoodin kommentointi
title_fullStr Lähdekoodin kommentointi Lähdekoodin kommentointi
title_full_unstemmed Lähdekoodin kommentointi Lähdekoodin kommentointi
title_short Lähdekoodin kommentointi
title_sort lähdekoodin kommentointi
title_txtP Lähdekoodin kommentointi
topic kommentointi source code documentation commenting programming Tietotekniikka Mathematical Information Technology 602 ohjelmointi dokumentointi lähdekoodit
topic_facet 602 Mathematical Information Technology Tietotekniikka commenting documentation dokumentointi kommentointi lähdekoodit ohjelmointi programming source code
url https://jyx.jyu.fi/handle/123456789/71889 http://www.urn.fi/URN:NBN:fi:jyu-202009285964
work_keys_str_mv AT jallowmusa lähdekoodinkommentointi