Un singur comentariu

Programare defensivă în R

Colin Gillespie

Jumping Rivers

Nu știu despre dumneavoastră...

  • Codul care pare evident astăzi
  • Este adesea mult mai puțin evident după câteva săptămâni
Programare defensivă în R

Comentarii

  • Puteți adăuga comentarii în codul R folosind #
  • Scrierea comentariilor bune este mai dificilă decât pare!
# This is a comment
# The above comment isn't very helpful
# Or is it?
Programare defensivă în R

Sfat 1: Evitați comentariile evidente

  • Ce este evident poate fi greu de stabilit
    • De exemplu, comentariile
       # Loop through data sets
 for (dataset in datasets) {
  # Read in data set
  r <- read.csv(dataset)
 }
      par rezonabile
    • Dar sunt poate puțin prea evidente
Programare defensivă în R

Sfat 2: Evitați comentariile pe care nu le veți actualiza

Cel mai frecvent exemplu sunt comentariile antet din partea de sus a fișierului

# Last updated: 1967-02-25
# Author: D Law
# Status: No 1
  • Aceste comentarii sunt aproape niciodată actualizate
  • Am văzut odată # list of packages used: XXX, YYY
Programare defensivă în R

Sfat 3: Fiți consecvent

  • Începeți întotdeauna cu # simplu sau ## dublu
  • Începeți cu literă mare – respectați regulile gramaticale
  • Fiți atenți cu glumele
    • Ceea ce vi se pare amuzant poate ofensa pe alții
  • Comentați codul care „pare greșit"
  • Folosiți # TODO sau # XXX pentru a indica o problemă viitoare
Programare defensivă în R

Să exersăm!

Programare defensivă în R

Preparing Video For Download...