Advanced R之编程风格
编程风格指导
好的编码风格如同正确使用标点符号一样重要。没有编码规范仍然可以管理代码,但是有代码规范会使代码更易阅读。如同标点样式,编码规范也有不同。下面描述的是我所使用的编码规范(在本书及其他地方)。该编码规范基于谷歌的R style guide,稍有修改。你不必使用这种编码规范,但是你应该保持一种编码风格。
好的编码风格很重要,因为虽然你的代码只有一个作者,却有很多读者。如果你和其他人一起编码,这就更加重要了。在这种情况下,事先确定一套编码规范是个好主意。没有哪种编码风格比另一种更好之说,所以与其他人一同编码,你需要做出妥协选择一些并不是你最爱的风格。
Yihui Xie写了一个包叫做formatR,可以清理格式很差的代码。它不能完成所有的事情,但是可以快速的对糟糕的代码进行改善。使用之前务必阅读简介(the introduction)
注释与命名
文件名称
文件名称应该有意义,并且以.R结尾。
# Good
fit-models.R
utility-functions.R # Bad
foo.r
stuff.r
如果文件需要按照顺序执行,命名时在文件名称前面加上次序编号:
-download.R
-parse.R
-explore.R
对象名称
“计算机科学只有2件事情难搞:缓存有效性和命名。”
— Phil Karlton
变量和函数名称应该是小写的。在名称中利用下划线分割单词。一般情况下,变量名称应该是名词,函数名称应该是动词。尽量保证名称含义明确且准确(这很不容易!)。
# Good
day_one
day_1 # Bad
first_day_of_the_month
DayOne
dayone
djm1
尽量避免使用已有的函数名和变量名。不然会对读者造成困惑。
# Bad
T <- FALSE
c <-
mean <- function(x) sum(x)
语法
空格
在中缀运算符(=,+,-,<-等)的前后使用空格。使用=调用函数时也是如此。逗号后面使用空格,前面不使用(就像正规英文)。
# Good
average <- mean(feet / + inches, na.rm = TRUE) # Bad
average<-mean(feet/+inches,na.rm=TRUE)
这里有个例外,即:,::和:::,这3个符号不需要前后加空格。
# Good
x <- :
base::get # Bad
x <- :
base :: get
在括号的左侧使用空格,除非是在调用函数。
# Good
if (debug) do(x)
plot(x, y) # Bad
if(debug)do(x)
plot (x, y)
为了对齐等号或者赋值(<-),额外的空格(比如一行中多个空格)是ok的。
list(
total = a + b + c,
mean = (a + b + c) / n
)
不要在括号或者方括号内侧(除非有逗号,如上所述)放置空格。
# Good
if (debug) do(x)
diamonds[, ] # Bad
if ( debug ) do(x) # No spaces around debug
x[,] # Needs a space after the comma
x[ ,] # Space goes after comma not before
花括号
左花括号后面应该总是另起一个新行。右花括号应该总是独占一行,除非后面有else。
花括号内部应该总是缩进的。
# Good if (y < && debug) {
message("Y is negative")
} if (y == ) {
log(x)
} else {
y ^ x
} # Bad if (y < && debug)
message("Y is negative") if (y == ) {
log(x)
}
else {
y ^ x
}
非常短的代码可以放在一行:
if (y < && debug) message("Y is negative")
一行的长度
尽量保证一行代码不超过80个字符。在使用合理字体大小的情况下,这正好适合打印。如果发现超出了,说明你也许应该单独封装一个函数出来。
缩进
代码缩进时,使用2个空格而不是tab键或者混合使用tab键和空格。
唯一的例外是如果函数定义跨越了多行。这种情况下,缩进第二行到缩进开始的地方:
long_function_name <- function(a = "a long argument",
b = "another argument",
c = "another long argument") {
# As usual code is indented by two spaces.
}
赋值
赋值使用<-而不是=。
# Good
x <-
# Bad
x =
代码组织
注释
给代码添加注释。每行注释应该由#开始,紧跟一个空格。注释应该解释为什么,而不是是什么。
使用由-或者=组成的注释线,将文件划分为容易阅读的代码块。
# Load data --------------------------- # Plot data ---------------------------
Advanced R之编程风格的更多相关文章
- R 语言编码风格指南
R 语言是一门主要用于统计计算和绘图的高级编程语言.这份 R 语言编码风格指南旨在让我们的 R代码更容易阅读.分享和检查.以下规则系与 Google 的 R 用户群体协同设计而成. 概要: R编码风格 ...
- Google Java编程风格指南
出处:http://hawstein.com/posts/google-java-style.html 声明:本文采用以下协议进行授权: 自由转载-非商用-非衍生-保持署名|Creative Comm ...
- 来自 Google 的 R 语言编码风格指南
来自 Google 的 R 语言编码风格指南R 语言是一门主要用于统计计算和绘图的高级编程语言. 这份 R 语言编码风格指南旨在让我们的 R 代码更容易阅读.分享和检查. 以下规则系与 Google ...
- Google Java编程风格指南中文版
作者:Hawstein出处:http://hawstein.com/posts/google-java-style.html声明:本文采用以下协议进行授权: 自由转载-非商用-非衍生-保持署名|Cre ...
- Java学习笔记(四)——google java编程风格指南(上)
[前面的话] 年后开始正式上班,计划着想做很多事情,但是总会有这样那样的打扰,不知道是自己要求太高还是自我的奋斗意识不够?接下来好好加油.好好学学技术,好好学习英语,好好学习做点自己喜欢的事情,趁着自 ...
- (转)google Java编程风格中文版
转:http://www.hawstein.com/posts/google-java-style.html 目录 前言 源文件基础 源文件结构 格式 命名约定 编程实践 Javadoc 后记 前言 ...
- Google的Java编程风格指南(Java编码规范)
这份文档是Google Java编程风格规范的完整定义.当且仅当一个Java源文件符合此文档中的规则, 我们才认为它符合Google的Java编程风格. 与其它的编程风格指南一样,这里所讨论的不仅仅是 ...
- C与C++的编程风格区别
c和c++都是在实践中发展起来的语言.实用性极强.c是与UNIX/Linux的发展相辅相成的.而C++是B.S为了摆脱c与硬件以及底层过于紧密的苦恼,而开发的语言.C++可以说就是c语言的超集.任何c ...
- R语言编程艺术(3)R语言编程基础
本文对应<R语言编程艺术> 第7章:R语言编程结构: 第9章:面向对象的编程: 第13章:调试 ============================================== ...
随机推荐
- linux history 命令 禁用history
保存在.bash_history文件中,默认1000条,你也可以更改这个 值 !!:上一个指令 !number 运行第几个指令 查看命令历史的时间戳,那么可以执行: # export HISTTIME ...
- spring boot json 首字母大小写问题解决方案
spring boot默认使用的json解析框架是jackson,对于.net转java的项目来说太坑了,首字母大写的属性会自动转为小写,然后前端就悲剧了,十几个属性的ViewModel增加几个Js ...
- AWS:2.根设备类型、EC2生命周期状态、User Data
主要内容 1.根设备类型 linux: /dev/sda1 windows: 系统盘 2.实例生命周期 生命周期状态:停止.终止.重启 3.用户数据(UserData) 实例在初始化,运行之前给定的用 ...
- power law 幂定律
y=cx∧a 卖品销量排名与销量
- php调用短网址接口
<?php $ch=curl_init(); curl_setopt($ch,CURLOPT_URL,"http://dwz.cn/create.php"); curl_se ...
- mooc课程mit6.00.1x--problem set1解决方法
counting vowels: 计算字符串中含有元音字母aeiou的数量 char = 'azcbobobegghakl' num = 0 #利用in方法直接查找字符串char中含有的元音字母数量 ...
- 1000个圆点与PaintDC的使用,OnSize时重画很棒
import wx import random class View(wx.Panel): def __init__(self, parent): super(View, self).__init__ ...
- 【题解】P1613跑路
[题解]P1613 鸽王跑路 一道思维好题! 考虑\(2^k\)的传递性.直接64遍\(floyd\)求所有\(2^k\)的路径,转移方程是 \(dp(i,j,k)=[dp[i][t][k-1]\)& ...
- 我的Android进阶之旅------>Android使用正则表达式匹配扫描指定目录下的所有媒体文件(音乐、图像、视频文件)
今天使用正则表达式匹配指定目录下的所有媒体文件,下面将这份代码简化了,可以收藏下来,当作工具类. package match; import java.io.File; import java.uti ...
- nodejs中的子进程,深入解析child_process模块和cluster模块
Node.js的进程管理 node遵循的是单线程单进程的模式,node的单线程是指js的引擎只有一个实例,且在nodejs的主线程中执行,同时node以事件驱动的方式处理IO等异步操作.node的 ...