Keep it simple, stupid!
Noen ganger er vi fryktelig lure, og det er fort gjort å være for lur når man er godt inne i et problem og forstår kontekst og domene. Men husk at andre (og deg selv om noen dager/uker/måneders tid) skal lese og forstå koden uten den konteksten du er inne i akkurat idet du skriver den. Det er ikke alltid lurt å skrive den mest komprimerte koden som finnes, benytt deg av kjente kodemønstre som dere er vant med på prosjekt og vær pragmatisk!
Kommentering av kode
Hvis du lager en superkompleks formel, eller bare har fått en dato du må filtrere på fra en eller annen, skriv en kommentar på hvorfor akkurat dette må være sånn. Og hvis det ikke må være sånn - kanskje det går an å skrives enklere? En kommentar som den under (tatt fra et reelt prosjekt), indikerer at variabelnavnet på modellen er feil. Da er det bedre å refaktorere koden, enn å introdusere masse variabler som mest sannsynlig vil brukes andre steder enn der kommentaren er synlig.
Som hovedregel er det greit å ikke kommentere for mye. Koden skal være selvdokumenterende og semantisk enkel å forstå med gode navn på variabler og funksjoner. Men ved unntak eller veldig kontekst-spesifikk kode, hjelper det lang på vei med en setning eller to som forklarer hvorfor det må være sånn.
Last updated