Kommentarer och Dokumentation

Kommentarer

Ibland vill vi skriva kommentarer i koden, utan att systemet uppfattar det som kod. Utan istället endast som info-kommentarer.

Dels för att vi vill komma ihåg saker, eller för att vi vill tydliggöra information för oss själva eller kollegor.

Dock ska koden helt vara tydlig nog att förstår utan kommenterar.

Alltså att namnet på funktionerna och variablerna ska vara lätta att förstå även utan kommentarer.

men kommentarer är ett bra understöd, speciellt när vi tränar nu i början.

Olika kodspråk har lite olika sätt att skriva kommenterar på.

Nedan följer exempel på kommentarer i Java och Javascript

Kommentera bort EN rad

Med “ // “ kan du skriva kommentarer på en specifik kodrad.

Som text

// Denna text kommer att ignoreras av kodsystemet

// Bra för minnesanteckningar och stöd-info

2. Kommentera bort FLERA rader

Om vi vill kommentera längre stycken kan vi starta och avsluta en lång kommentar med “ /* “ & “ */ ”

Exempel:

/* Nu kommer all denna text

att helt ignoreras av systemet

fram tills dess att vi avslutar kommentaren med */

⁠

Dokumentation

Dokumentation är information och beskrivningar kring kod, kodsamlingar (bibliotek) och ramverk.

Det är något man redan nu kan vänja sig vid att läsa när man lär sig ett nytt område eller nytt verktyg inom kodning.

Även erfarna programmerare sätter sig in i dokumentation (instruktioner och förklaringar) kring nya kodsystem, kodsamlingar (bibliotek) och nya ramverk när de utforskar nytt eller ifall nya uppdateringar kommer ut.

Want to print your doc?
This is not the way.

Try clicking the ⋯ next to your doc name or using a keyboard shortcut (

CtrlP

) instead.