แค่คอมเมนต์เดียว

การเขียน R แบบ Defensive Programming

Colin Gillespie

Jumping Rivers

ไม่รู้ว่าเป็นแค่เราคนเดียวหรือเปล่า...

  • โค้ดที่ดูชัดเจนในวันนี้
  • มักจะเข้าใจยากขึ้นมากในอีกไม่กี่สัปดาห์
การเขียน R แบบ Defensive Programming

คอมเมนต์

  • เพิ่มคอมเมนต์ในโค้ด R ได้โดยใช้ #
  • การเขียนคอมเมนต์ที่ดีนั้นไม่ง่ายอย่างที่คิด!
# This is a comment
# The above comment isn't very helpful
# Or is it?
การเขียน R แบบ Defensive Programming

เทคนิคที่ 1: หลีกเลี่ยงคอมเมนต์ที่ชัดเจนเกินไป

  • สิ่งที่ "ชัดเจน" บางครั้งก็ตัดสินได้ยาก
    • ตัวอย่างเช่น คอมเมนต์เหล่านี้
       # Loop through data sets
 for (dataset in datasets) {
  # Read in data set
  r <- read.csv(dataset)
 }
      ดูสมเหตุสมผล
    • แต่อาจชัดเจนเกินไปเล็กน้อย
การเขียน R แบบ Defensive Programming

เทคนิคที่ 2: หลีกเลี่ยงคอมเมนต์ที่จะไม่ถูกอัปเดต

ตัวอย่างที่พบบ่อยที่สุดคือคอมเมนต์ส่วนหัวที่ด้านบนของไฟล์

# Last updated: 1967-02-25
# Author: D Law
# Status: No 1
  • คอมเมนต์ประเภทนี้แทบไม่เคยถูกอัปเดต
  • เคยเห็น # list of packages used: XXX, YYY มาแล้ว
การเขียน R แบบ Defensive Programming

เทคนิคที่ 3: ให้สม่ำเสมอ

  • เริ่มต้นด้วย # หนึ่งตัวหรือ ## สองตัวเสมอ
  • ขึ้นต้นด้วยตัวพิมพ์ใหญ่ — ตามหลักไวยากรณ์
  • ระวังเรื่องการใช้มุกตลก
    • สิ่งที่คิดว่าตลก อาจทำให้คนอื่นรู้สึกไม่ดีได้
  • ควรเขียนคอมเมนต์สำหรับโค้ดที่ "ดูผิดปกติ"
  • ใช้ # TODO หรือ # XXX เพื่อระบุปัญหาที่จะแก้ในอนาคต
การเขียน R แบบ Defensive Programming

มาฝึกกันเถอะ!

การเขียน R แบบ Defensive Programming

Preparing Video For Download...