Miten kirjoittaa ”hyvää perintökoodia”
Tässä on muutamia nopeita lähtökohtia hyvän perintökoodin kirjoittamiseen. Koodi on paljon helpompi kirjoittaa kuin lukea, ja paras tapa korjata ongelmia on olla luomatta niitä.
Kirjoita vähemmän koodia
Vähemmän koodia = vähemmän potentiaalisia virheitä = vähemmän ylläpidettävää = vähemmän ”huonoa perintöä”.
Vähemmän koodin kirjoittamista voidaan pitää tärkeimpänä yksittäisenä tapana parantaa koodia yleensä. DRY-periaatetta voidaan pitää luonnollisena seurauksena ja ensisijaisena keinona kirjoittaa vähemmän ja saavuttaa enemmän.
Vältä // TODO ja // FIXME
Kirjoittamista // TODO tai // FIXME tulisi pitää punaisena lippuna ja koodin haistamisena.
Jos käännetään nämä kommentit niiden todellisiin merkityksiin, niin ”TODO” kääntyy muotoon ”luodaan teknisiä velkoja”, ja ”FIXME” kääntyy muotoon ”kirjoitan tahallani bugia”.
Voi olla harvinaisia poikkeuksia, joissa ratkaisun lykkääminen on tärkeämpää kuin sen ratkaisemisesta nyt saatava hyöty, mutta yleisesti ottaen TODO ja FIXME tulisi pitää minimissään.
Preferoi vakiintuneita idiomeja huipputeknologian sijasta
Tämä saattaa tuntua ristiriitaiselta… Verenvuodatuksen teknologioiden käyttäminen tekee koodista ”uudempaa”, eikö? No, kyllä, mutta se luo myös mahdollisuuden vanhentua nopeammin.
Se myös vaikeuttaa uusien ohjelmoijien selvittämistä. Jos koodi on kirjoitettu käyttäen vakiintuneita idiomeja ja kehyksiä, sitä on todennäköisesti helpompi lukea ja sillä on paremmat mahdollisuudet toimia pidempään tulevaisuudessa.
Jätä koodi aina parempaan kuntoon kuin mihin sen löysit
Tämä saattaa tuntua ristiriitaiselta alussa mainitun ”ei uudelleenkirjoittamista” -periaatteen kanssa, mutta jatkuva parantaminen ja refaktorointi on kuitenkin eri asia kuin merkittävän uudelleenkirjoittamisen tekeminen.
Pyrkikää hankkimaan itsellenne tapana parannella asioita pikkuhiljaa ja vaiheittain. Joskus suuri refaktorointi tai uudelleenkirjoitus on aidosti tarpeen, mutta sen liiketoiminnallista arvoa on punnittava huolellisesti muihin prioriteetteihin nähden.
Kehity ohjelmoijana
Lue kirjoja, lue blogikirjoituksia, lue muiden ihmisten koodia, mieti huolellisesti suunnittelu- ja ohjelmointikäytäntöjä. Pohdi tietoisesti omaa koodiasi ja mieti tapoja, joilla voit parantaa sitä.
Ennemmin kuin syytät edellistä ohjelmoijaa huonon perinnön jättämisestä, varmista, ettei sinusta tule ohjelmoijaa, joka luo uuden perinnön.