R语言编码规范

1.一般性规则

(1)避免使用attach
(2)写函数时尽量少的使用stop()
(3)定义S3和S4的对象不要混在一起使用。

2.文件命名

(1)文件名应以.R结尾,文件名本身要有意义,如:predict_ad_revenue.R
(2)R代码就放在.R文件中,而R数据文件则放在.RData文件中。

3.变量名和函数命名规则

注意,在R环境下,大小写是敏感的。
1.变量名应都用小写字母,单词间用.分隔。
2.函数名的每个单词用大写字母开头,不用.连接。
3.常数项与函数命名规则一致,但以小写k开头。
以下举例说明:
变量:avg.clicks
函数名:CalculateAvgClicks用动词命名函数;
常数项:kConstantName

4.R语句

(1)单行长度
每行最长80个字符。
(2)缩进
使用两个空格来缩进代码,不要使用制表符或混合使用二者。
(3)空格
1.在所有二次运算符(=,+,-,<-,等)的两侧加上空格。
2.不可在逗号前加空格,逗号后必须加空格。
例如:tabPrior <- table(df[df$daysFromOpt < 0, "campaignid"])
3.括号左边用空格,调用函数时除外。例如:if (debug)
4.可以多使用空格(一行中有多个空格),如果这能够改善符号间的对齐。
圆括号或方括号内的代码两侧不要加空格,逗号后面除外。
(4)花括号
1.开始的{不能单独成行,结束的}必须单独成行,如:

if (is.null(ylim)) {
  ylim <- c(0, 0.06)
}

2.单独的一个语句应从新的一行开始。
(5)赋值
使用 <- 进行赋值,不用 = 赋值。

5.代码组织

如果是做项目或者多人合作,便于所有人都能快速阅读并理解他人的脚本,以下信息是必须有的:
a)版权声明注释
b)作者信息注释
c)文件说明注释(包括程序的用途,输入,输出)
d)source()library()语句说明
e)函数定义

6.注释

开发工程师应养成良好的注释习惯。
整行注释以 # 开头,加一个空格,如:# Create histogram of frequency
行内短注释需要在代码后面空两格,然后 # ,再加一个空格,如:

    hist(df$pctSpent,
    breaks = "scott",  # method for choosing number of buckets
    x     = "Frequency (count of campaignids)")

7.函数定义与调用

函数定义应首先列出无默认值的参数,然后再列出有默认值的参数。
在函数定义和调用时,允许每行写多个参数,一般只在赋值时才换行。如:

PredictCTR <- function(query, property, numDays,
    showPlot = TRUE)

在函数的定义行下方应当紧接一个注释区,包括:
-描述函数的作用
-描述函数的参数列表,用Args:对每个参数进行描述(包括数据类型)
-描述返回值,用Returns:
注释部分应尽可能详细充分,以便调用者在不阅读代码时就能使用该函数。

你可能感兴趣的:(R语言编码规范)