Ohjelmointikäytännöt ja dokumentointi
Onatsu, Joonas (2018)
Onatsu, Joonas
Savonia-ammattikorkeakoulu
2018
All rights reserved
Julkaisun pysyvä osoite on
https://urn.fi/URN:NBN:fi:amk-2018102516255
https://urn.fi/URN:NBN:fi:amk-2018102516255
Tiivistelmä
Tämän opinnäytetyön tavoitteena oli kehittää ohjelmointi- ja dokumentointikäytäntö Delfin Technologies Oy:n
tuotekehitysosastolle.
Työn aloitettiin tutustumalla ohjelmiston laatuun vaikuttaviin tekijöihin. Pääasiallisesti tässä osuudessa keskityttiin
ohjelmointikäytäntöjen ja dokumentoinnin merkityksiin ohjelmiston laadun parantamisessa. Osiossa esitettiin esimerkkejä yritysten/yhteisöjen käyttämistä käytännöistä, sekä esimerkkejä huonosti kirjoitetun koodin aiheuttamasta koodin luettavuuden heikkenemisestä. Lisäksi osiossa perehdyttiin lääketieteelliseen käyttöön tarkoitettujen ohjelmistojen IEC 62304-standardiin.
Työn lopputuloksena koostettiin yleisistä ohjelmointi- ja dokumentointikäytännöistä parhaat käytännöt eli ns.
”best practices” ohjelmointi- ja dokumentaatiokäytäntödokumenttiin, ja olemassa olevat koodit päivitettiin ohjelmointikäytännön mukaiseksi. Lisäksi koodit dokumentointiin Doxygen-työkalulla.
tuotekehitysosastolle.
Työn aloitettiin tutustumalla ohjelmiston laatuun vaikuttaviin tekijöihin. Pääasiallisesti tässä osuudessa keskityttiin
ohjelmointikäytäntöjen ja dokumentoinnin merkityksiin ohjelmiston laadun parantamisessa. Osiossa esitettiin esimerkkejä yritysten/yhteisöjen käyttämistä käytännöistä, sekä esimerkkejä huonosti kirjoitetun koodin aiheuttamasta koodin luettavuuden heikkenemisestä. Lisäksi osiossa perehdyttiin lääketieteelliseen käyttöön tarkoitettujen ohjelmistojen IEC 62304-standardiin.
Työn lopputuloksena koostettiin yleisistä ohjelmointi- ja dokumentointikäytännöistä parhaat käytännöt eli ns.
”best practices” ohjelmointi- ja dokumentaatiokäytäntödokumenttiin, ja olemassa olevat koodit päivitettiin ohjelmointikäytännön mukaiseksi. Lisäksi koodit dokumentointiin Doxygen-työkalulla.