Bara en kommentar
Defensiv R-programmering
Colin Gillespie
Jumping Rivers
Det vet du säkert själv...
- Kod som är självklar idag
- Är ofta mycket mindre självklar om några veckor
Kommentarer
- Du lägger till kommentarer i R-kod med
# - Att skriva bra kommentarer är dock inte helt enkelt!
# This is a comment
# The above comment isn't very helpful
# Or is it?
Tips 1: Undvik uppenbara kommentarer
- Det kan vara svårt att avgöra vad som är självklart
- Till exempel är kommentarerna
rimliga# Loop through data sets for (dataset in datasets) { # Read in data set r <- read.csv(dataset) } - Men kanske lite för uppenbara
- Till exempel är kommentarerna
Tips 2: Undvik kommentarer du aldrig kommer att uppdatera
Det vanligaste exemplet är rubrikkommentarer längst upp i filen
# Last updated: 1967-02-25
# Author: D Law
# Status: No 1
- Den här typen av kommentarer uppdateras nästan aldrig
- Jag såg en gång
# list of packages used: XXX, YYY
Tips 3: Var konsekvent
- Inled alltid med enkel
#eller dubbel## - Börja med stor bokstav – följ grammatikens regler
- Var försiktig med skämt
- Det du tycker är roligt kan uppfattas som stötande av andra
- Kommentera alltid kod som "ser fel ut"
- Använd # TODO eller # XXX för att markera framtida problem
Nu kör vi en övning!
Defensiv R-programmering
