Bra kodkommentarer
Förklara varför, viktiga antaganden och sådant som kan överraska nästa utvecklare.
Skrivande och dokumentation
↑Bra dokumentation ska gå att förstå även flera månader senare. Den som läser kan vara en kollega, en granskare eller du själv när du återvänder till en gammal lösning.
Börja med läsarens fråga
Section titled “Börja med läsarens fråga”Skriv vad personen ska kunna göra efter sidan. Ett tydligt namn som “Så fungerar triggers i Unity” hjälper mer än “Mina anteckningar”. Ge ett kort svar först och bygg sedan upp en grundlig förklaring.
Tydliga guider
Visa förutsättningar, ett litet fungerande exempel och hur resultatet kontrolleras.
En enkel struktur
Section titled “En enkel struktur”- Snabböversikt. Ge det viktigaste först.
- Fördjupning. Förklara mekanismen och varför den spelar roll.
- Exempel och kod. Ange språk och förväntat resultat.
- Vanliga misstag. Berätta om gränsfall och felkällor.
- Kontrollera. Visa hur läsaren kan testa påståenden.
- Läs vidare. Länka till mer detaljerad dokumentation.
Läs kodkommentarer och dokumentationsstruktur för fler praktiska råd.