樣式

提示

如果你希望程式碼可以複製,請在每個新行的開頭刪除提示,例如 R>>+。一些 Docs 作者更喜歡不復制貼上,這沒關係。

控制檯輸出

控制檯輸出應與程式碼明確區分開來。常見方法包括:

  • 在輸入上包含提示(使用控制檯時可以看到)。
  • 註釋所有輸出,每行開始 ###
  • 按原樣列印,信任領先的 [1],使輸出從輸入中脫穎而出。
  • 在程式碼和控制檯輸出之間新增一個空行。

分配

=<- 適合分配 R 物件。適當使用空格以避免編寫難以解析的程式碼,例如 x<-1x <- 1x < -1 之間不明確)

程式碼評論

務必解釋程式碼本身的目的和功能。關於這種解釋是應該用散文還是程式碼註釋,沒有任何嚴厲的規則。散文可能更具可讀性,並允許更長的解釋,但程式碼註釋使複製貼上更容易。記住這兩個選項。

很多例子都很短,不需要部分,但如果使用它們,請從 H1 開始。