R/Bioconductor的书写规范
Bioconductor format rules
R/Bioconductor的书写规范并不是硬性要求,但是可以帮助我们写出方便和他人交流的代码。
退格与列
使用4个空格来替换tab
每一行不超过80个字符
变量名
使用匈牙利命名法:以一个或者多个小写字母起始,接着首字母大写的单词缩写,中间不使用除字母与数字以外的其它字符。比如someVar1。
函数名
使用匈牙利命名法:以一个或者多个小写字母起始,接着首字母大写的单词缩写,中间不使用除字母与数字以外的其它字符。
避免使用'.',比如some.func
合理使用空格
在逗号后一定使用空格。比如a, b, c。而不应该是a,b,c。这样做有利于系统自动换行。
在函数传递参数时等号(=)左右不使用空格。比如someFunc(a=1, b=2),而不应该是someFunc(a = 1, b = 2)。
在逻辑运算符左右使用空格,比如a == b。
在赋值运算符左右使用空格,比如a <- 2。
注释
使用连续两个##开始注释
注释需要和代码的退格保持一致
其它
使用'<-'而不是'='作为赋值符号
参考
生物信息学生R入门教程