就加一句註解

R 防禦式程式設計

Colin Gillespie

Jumping Rivers

我不確定你怎麼想……

  • 今天看起來很明顯的程式碼
  • 幾週後常常就不那麼明顯了
R 防禦式程式設計

註解

  • 你可以用 # 在 R 程式碼裡加上註解
  • 不過，要寫出好的註解並不容易！
# 這是一行註解
# 上面的註解其實不太有幫助
# 真的是嗎？
R 防禦式程式設計

技巧 1：避免過於明顯的註解

  • 什麼算「明顯」有時不易判斷
    • 例如，以下註解
       # 逐一走訪資料集
 for (dataset in datasets) {
  # 讀入資料集
  r <- read.csv(dataset)
 }
      看起來合理
    • 但也許過於明顯了
R 防禦式程式設計

技巧 2：避免永遠不會更新的註解

最常見的例子是檔案開頭的標頭註解

# 最後更新：1967-02-25
# 作者：D Law
# 狀態：No 1
  • 這類註解幾乎不會有人更新
  • 我還看過 # list of packages used: XXX, YYY
R 防禦式程式設計

技巧 3：保持一致

  • 一律以單一 # 或雙重 ## 開頭
  • 句首用大寫字母——遵守文法規則
  • 小心玩笑話
    • 你覺得好笑，別人可能會介意
  • 對「看起來不對勁」的程式碼務必加註解
  • 用 # TODO 或 # XXX 標示待處理問題
R 防禦式程式設計

一起來練習吧！

R 防禦式程式設計

Preparing Video For Download...