Cukup satu komentar

Pemrograman R Defensif

Colin Gillespie

Jumping Rivers

Entah Anda bagaimana...

  • Kode yang hari ini terasa jelas
  • Sering jadi jauh kurang jelas beberapa minggu lagi
Pemrograman R Defensif

Komentar

  • Anda dapat menambahkan komentar di R dengan #
  • Menulis komentar yang baik ternyata tidak mudah!
# Ini komentar
# Komentar di atas kurang membantu
# Atau justru membantu?
Pemrograman R Defensif

Tips 1: Hindari komentar yang terlalu jelas

  • Apa yang “jelas” kadang sulit diputuskan
    • Misalnya, komentar berikut
       # Loop melalui data set
 for (dataset in datasets) {
  # Baca data set
  r <- read.csv(dataset)
 }
      tampak wajar
    • Namun mungkin terlalu jelas
Pemrograman R Defensif

Tips 2: Hindari komentar yang tidak akan Anda perbarui

Contoh paling umum adalah komentar header di awal berkas

# Terakhir diperbarui: 1967-02-25
# Penulis: D Law
# Status: No 1
  • Komentar seperti ini hampir tidak pernah diperbarui
  • Saya pernah melihat # daftar paket yang dipakai: XXX, YYY
Pemrograman R Defensif

Tips 3: Konsisten

  • Selalu mulai dengan satu # atau dua ##
  • Awali dengan huruf kapital—ikuti kaidah tata bahasa
  • Hati-hati dengan lelucon
    • Yang lucu bagi Anda bisa menyinggung orang lain
  • Beri komentar pada kode yang “terlihat salah”
  • Gunakan # TODO atau # XXX untuk menandai masalah ke depan
Pemrograman R Defensif

Ayo berlatih!

Pemrograman R Defensif

Preparing Video For Download...