Ohjelmointikäytännöt ja dokumentointi

Abstract

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.

The purpose of this thesis was to develop coding guidelines and documentation practices for the product development department of Delfin Technologies Oy.

The thesis was started by going through the factors affecting software quality. The focus on the software quality section was to investigate what kind of effect coding guidelines and documentation have on software quality. Few examples of publicly available coding guidelines were studied and presented as well as few examples of badly written code to show the degrading effect on code readability. The IEC 62304 medical device software standard was also studied and the effect it has on coding guidelines and documentation.

As a result of this thesis, the best practices from publicly available coding guidelines were collected and incorporated in to the coding guidelines and documentation document. The existing codes were also updated to conform with the coding guidelines, and the codes were documented with Doxygen.