Slechts één commentaar

Defensief programmeren in R

Colin Gillespie

Jumping Rivers

Ik weet niet hoe het met jou zit...

  • Code die vandaag duidelijk is
  • Is over een paar weken vaak veel minder duidelijk
Defensief programmeren in R

Commentaar

  • Je kunt commentaar toevoegen aan je R-code met #
  • Goed commentaar schrijven is lastig!
# Dit is een commentaarregel
# Bovenstaand commentaar helpt niet echt
# Of wel?
Defensief programmeren in R

Tip 1: Vermijd voor de hand liggend commentaar

  • Wat duidelijk is, is soms lastig te bepalen
    • Bijvoorbeeld, de commentaren
       # Doorloop datasets
 for (dataset in datasets) {
  # Lees dataset in
  r <- read.csv(dataset)
 }
      lijken redelijk
    • Maar zijn misschien wat te voor de hand liggend
Defensief programmeren in R

Tip 2: Vermijd commentaar dat je nooit bijwerkt

Het meest voorkomende voorbeeld is header-commentaar bovenaan het bestand

# Laatst bijgewerkt: 1967-02-25
# Auteur: D Law
# Status: Nr 1
  • Dit soort commentaar wordt bijna nooit bijgewerkt
  • Ik zag ooit # list of packages used: XXX, YYY
Defensief programmeren in R

Tip 3: Wees consistent

  • Begin altijd met één # of twee ##
  • Begin met een hoofdletter – volg de grammaticaregels
  • Wees voorzichtig met grappen
    • Wat jij grappig vindt, kan een ander kwetsen
  • Licht code toe die “fout” oogt
  • Gebruik # TODO of # XXX voor uitgestelde issues
Defensief programmeren in R

Laten we oefenen!

Defensief programmeren in R

Preparing Video For Download...