R代码规范笔记

1、文件命名

以.r结束的文件,尽可能的增加信息在文件名里面。

比如 Good: predict_ad_revenue.R、Bad: foo.R 

2、变量名和函数命名规则 

在R环境下,大小写是敏感的。

比如:

变量: Good: avg.clicks Bad: avg_Clicks, avgClicks 

函数名: Good: CalculateAvgClicks Bad: calculate_avg_clicks, calculateAvgClicks 

3、字符间隔 

这个可能是最快的,使代码外观变“漂亮”的规则了 。

Good: tabPrior <- table(df[df$daysFromOpt < 0, "campaignid"]) 

Bad: tabPrior<-table(df[df$daysFromOpt<0,"campaignid"]) 

这里包含了赋值、逻辑符号以及逗点分隔。

在R里面尽量少用 = 在函数里: Good: if (debug) Bad: if(debug) 。

4、代码组织

尤其是做项目的话,以下信息是必须有的: 版权声明、作者注释、文件说明、项目目的、输入和输出的说明 source() 和 library() 说明、函数定义、其他 。

5、注释

养成良好的注释习惯,单行注释以 # 开头,加一个空格。短注释需要在代码后面空两格,然后 # ,再加一个空格。

猜你喜欢

转载自blog.csdn.net/yaroo/article/details/79743377
今日推荐