编码风格
创建日期:古代。最后编辑日期:2015年8月13日。
使用相似的编码风格可以帮助人们理解代码。这些指导方针是首选并受到强烈鼓励。
缩进
- 使用4个空格缩进。没有标签。
- 每行不超过80个字符。
变量名
- 使用camelCaps:开头小写,然后在单词之间交替使用大小写。
函数名
- 使用camelCaps:初始小写,然后在单词之间交替使用大小写。
- 不要使用'。’(在S3课程系统中,
一些(x)
在哪里x
是类一个
将派遣some.A
)。
- 用' . '前缀非导出函数。
类名
- 使用CamelCaps:首字母大写,然后在单词之间交替使用大小写。
文件名
- R代码的扩展名应该是' .R '。对S4类方法使用前缀' methods- ',例如' methods-coverage. r '。泛型定义可以列在一个文件‘AllGenerics’中。在' AllClasses.R '中定义类。
- 手册页的扩展名应该是' . rd '。
利用空间
- 逗号后面要加空格。这样的:
a, b, c
。
- 当对函数使用命名参数时,“=”周围没有空格。这样的:
somefunc (a = 1, b = 2)
- 所有二元运算符周围的空间:
a = =
。
评论
- 使用“##”来开始整行注释。
- 缩进与周围的代码在同一级别。
名称空间
- 导入包中使用的所有符号,而不是“base”。除了默认包(基本包、图形包、统计包等),或者当过于繁琐时,完全枚举导入。
- 导出所有对最终用户有用的符号。完全列举的出口。
最终用户信息
消息()
在代码评估期间沟通诊断信息(例如,在漫长的计算过程中的进展)。
警告()
传达代码处理的异常情况。
stop ()
表示错误条件。
猫()
或print ()
仅在向用户显示对象时使用,例如在a显示
方法。
Misc