做出好榜樣
為 Q&A 建立良好示例的大多數指導都會延伸到文件中。
-
儘量減少並達到目的。併發症和離題是適得其反的。
-
包括工作程式碼和散文解釋。這兩者都不夠。
-
不要依賴外部資料來獲取資料。如果可能,生成資料或使用資料集庫:
library(help = "datasets")
在 Docs 的上下文中還有一些額外的考慮因素:
-
只要相關,請參閱像
?data.frame
這樣的內建文件。SO Docs 不是試圖替換內建文件。確保新 R 使用者知道內建文件以及如何找到它們非常重要。 -
將適用於多個示例的內容移至備註部分。