Jen jeden komentář

Defenzivní programování v R

Colin Gillespie

Jumping Rivers

Nevím, jak vy...

  • Kód, který je dnes zřejmý
  • Bývá o pár týdnů později mnohem méně srozumitelný
Defenzivní programování v R

Komentáře

  • Komentáře v kódu R přidáme pomocí #
  • Psaní dobrých komentářů je ale náročné!
# This is a comment
# The above comment isn't very helpful
# Or is it?
Defenzivní programování v R

Tip 1: Vyhněte se zřejmým komentářům

  • Co je zřejmé, se občas těžko posuzuje
    • Například tyto komentáře
       # Loop through data sets
 for (dataset in datasets) {
  # Read in data set
  r <- read.csv(dataset)
 }
      vypadají rozumně
    • Ale jsou možná trochu příliš zřejmé
Defenzivní programování v R

Tip 2: Nepište komentáře, které nikdy neaktualizujete

Nejčastějším příkladem jsou záhlavní komentáře na začátku souboru

# Last updated: 1967-02-25
# Author: D Law
# Status: No 1
  • Tyto komentáře se téměř nikdy neaktualizují
  • Jednou jsem viděl # list of packages used: XXX, YYY
Defenzivní programování v R

Tip 3: Buďte konzistentní

  • Vždy začínejte jednoduchým # nebo dvojitým ##
  • Začínejte velkým písmenem – dodržujte gramatická pravidla
  • Buďte opatrní s vtipy
    • Co je zábavné pro vás, může jiné urazit
  • Nezapomeňte komentovat kód, který „vypadá špatně"
  • Používejte # TODO nebo # XXX k označení budoucích problémů
Defenzivní programování v R

Pojďme si procvičit!

Defenzivní programování v R

Preparing Video For Download...