Sadece bir yorum

Savunmacı R Programlama

Colin Gillespie

Jumping Rivers

Siz bilmem ama...

  • Bugün açık olan kod
  • Birkaç hafta sonra çoğu zaman daha az açık olur
Savunmacı R Programlama

Yorumlar

  • R kodunuza # ile yorum ekleyebilirsiniz
  • İyi yorum yazmak zor bir iştir!
# Bu bir yorumdur
# Yukarıdaki yorum pek yardımcı değil
# Yoksa öyle mi?
Savunmacı R Programlama

İpucu 1: Açık olan yorumlardan kaçının

  • Nelerin açık olduğu bazen zor bir karardır
    • Örneğin, şu yorumlar
       # Veri kümelerinde döngü yap
 for (dataset in datasets) {
  # Veri kümesini oku
  r <- read.csv(dataset)
 }
      makul görünüyor
    • Ama belki de biraz fazla açık
Savunmacı R Programlama

İpucu 2: Asla güncellemeyeceğiniz yorumlardan kaçının

En yaygın örnek, dosyanın başındaki başlık yorumlarıdır

# Son güncelleme: 1967-02-25
# Yazar: D Law
# Durum: No 1
  • Bu tür yorumlar neredeyse hiç güncellenmez
  • Bir kez # kullanılan paketler: XXX, YYY görmüştüm
Savunmacı R Programlama

İpucu 3: Tutarlı olun

  • Her zaman tek # veya çift ## ile başlayın
  • Büyük harfle başlayın - dilbilgisi kurallarına uyun
  • Şakalara dikkat edin
    • Sizin komik bulduklarınızı başkaları kırıcı bulabilir
  • "Hatalı görünüyor" gibi koda mutlaka yorum yazın
  • Gelecekteki bir sorunu belirtmek için # TODO veya # XXX kullanın
Savunmacı R Programlama

Haydi pratik yapalım

Savunmacı R Programlama

Preparing Video For Download...