Coding Standards in Web Development

Abstract

The purpose of this final year project was to collate and analyze knowledge on the theory of coding standards. The goal of the study was to create a hub of centralized knowledge, based on which it would be possible to investigate and debate the benefits and necessity of coding standards, and to create a basis for creating and maintaining coding standards.

The study found that coding standards and especially their stylistic components impact code legibility, and consequently maintainability and extendibility. Coding standards are reproached for being time-consuming and unnecessary, while in fact they save time in the long term by reducing the time required for code maintenance.

Conforming to a good coding standard is beneficial to all, but programmers are creatures of habit, which means that they are prone to slip from the standard due to aversion, habit, or time constraints. This is why coding standards require enforcement to ensure conformity.

The greatest obstacle for this project was the sparsity of theoretic knowledge. Scientific research regarding coding standards is scarce, so in that sense the project fulfilled its purpose – in conclusion, the thesis offers a collection of information, based on which it is possible to manage coding standards.

Insinöörityön tarkoituksena oli koota ja analysoida tietoa ohjelmointistandardeista. Tutkimuksen tavoitteena oli luoda tietokooste, jonka pohjalta olisi mahdollista selvittää ja perustella ohjelmointistandardien hyötyjä ja tarpeellisuutta sekä luoda perusta ohjelmointistandardien luomiselle ja ylläpitämiselle.

Tutkimuksessa ilmeni, että ohjelmointistandardit ja erityisesti niihin sisältyvät tyylilliset seikat vaikuttavat koodin luettavuuteen ja sitä kautta ylläpidettävyyteen ja kehitettävyyteen. Ohjelmointistandardeja pidetään aikaa vievinä ja tarpeettomina, vaikka ne tosiasiassa säästävät aikaa pitkällä tähtäimellä vähentämällä koodin vaatimaa ylläpitoaikaa.

Hyvän ohjelmointistandardin seuraaminen hyödyttää kaikkia, mutta ohjelmoijat ovat usein tapoihinsa juurtuneita, mikä tarkoittaa että standardista on helppo lipsua vastahakoisuuden, tottumuksen tai aikarajoitteiden vuoksi. Tämän vuoksi tarvitaan toimenpiteitä, jotka varmistavat, että ohjelmointistandardia noudatetaan.

Insinöörityön suurimmaksi ongelmaksi osoittautui teoriatiedon hajanaisuus. Ohjelmointistandardeja koskevaa tieteellistä tutkimusta on hyvin vähän, joten siinä mielessä työ saavutti tarkoituksensa: insinöörityön tulos on tietokokonaisuus, jonka pohjalta on mahdollista hallinnoida ohjelmointistandardeja.