样式
提示
如果你希望代码可以复制,请在每个新行的开头删除提示,例如 R>
,>
或+
。一些 Docs 作者更喜欢不复制粘贴,这没关系。
控制台输出
控制台输出应与代码明确区分开来。常见方法包括:
- 在输入上包含提示(使用控制台时可以看到)。
- 注释所有输出,每行开始
#
或##
。 - 按原样打印,信任领先的
[1]
,使输出从输入中脱颖而出。 - 在代码和控制台输出之间添加一个空行。
分配
=
和 <-
适合分配 R 对象。适当使用空格以避免编写难以解析的代码,例如 x<-1
(x <- 1
和 x < -1
之间不明确)
代码评论
务必解释代码本身的目的和功能。关于这种解释是应该用散文还是代码注释,没有任何严厉的规则。散文可能更具可读性,并允许更长的解释,但代码注释使复制粘贴更容易。记住这两个选项。
第
很多例子都很短,不需要部分,但如果使用它们,请从 H1 开始。