Citat:
Ursprungligen postat av
hrgh
Självdokumenterande kod är en myt för mig. Behövs mer än bara ritningarna till maskinen. Man vill även veta vad komponenterna ska göra, och vilka antaganden som gjorts.
Om koden inte är självdokumenterande anser jag att utvecklaren har misslyckats. Bra namn på variabler och funktioner räcker gott och väl för att en annan ska förstå vad som händer.
Jag är också av åsikten att kommentarer i regel är av ondo. Dels för att jag upplever att många kommentarer är redundanta, dels för att de sällan underhålls. När någon refaktoriserar eller utvidgar en funktion som någon annan har skrivit, är det lätt hänt att kommentarerna är oförändrade. Detta kan lätt bli vilseledande i det långa loppet. (Tro mig, när man har suttit i ett system med en kodbas uppemot 2 miljoner rader kod, är detta inte allt för ovanligt förekommande...)
Med det sagt är så klart inte kommentarer alltid onödigt. Har man en funktion som räknar ut något kan det vara intressant att referera till var någonstans man har tagit formeln ifrån. Detta underlättar för andra om det uppstår en bugg och andra utvecklare ska försöka ta tag i det.