Dokumentera, del II
Dags för del två i kod och dokumentations serien. Tänkte ägna denna åt den första av mins principer närhet. Med närhet menar jag att kod och dokumentation bör vara så nära varandra som möjligt. Ju närmare desto större chans att man läser, reflekterar och uppdaterar dokumentationen. Ju enklare det är att uppdatera ju större chans att den är korrekt. Detta leder också till att dokumentationen lever med kod och produkt och inte blir något som hanteras i efter hand. Det finns ett antal olika sätt att komma fram till en sådan situation. Jag föredrar att jobba med dokumentation i källkoden framför annan dokumentation. Många språk idag har stöd för detta i någon form, javadoc, pydoc eller likande. Finns detta är det det uppenbart bästa att jobba med finns det inte kan man titta på doxygen det det är enkelt och har fungerat i många projekt.
Det är också viktigt att man ser till att använda och uppdatera dessa kommentarer på ett bra sätt när man jobbar i den.
Popularity: 2% [?]
Additional comments powered by BackType