kodkommentarer
Kodkommentarer är text som finns i programkällkod men inte körs av programmet. Deras syfte är att förklara vad koden gör, varför vissa val har gjorts och hur komponenter ska användas. Bra kommentarer underlättar underhåll, vidareutveckling och överlämning till nya teammedlemmar.
Vanliga typer är inline-kommentarer som placeras bredvid en rad kod, blockkommentarer som avgränsas av särskilda start-
Kommentarernas placering bör spegla innehållet: de ska förklara komplex logik, antaganden eller användning av gränssnitt, inte
Dokumentationskommentarer används av verktyg för automatiserad dokumentation, som Javadoc, Doxygen eller Sphinx. De följer ofta särskilda
Bästa praxis inkluderar att skriva tydliga, koncisa och uppdaterade kommentarer. Undvik att kommentera det som redan