Google 的 R 语言编码风格指南.pdf

来自 Google 的 R 语言编码风格指南 摘要: R 语言是一门主要用于统计计算和绘图的高级编程语言. 这份 R 语言编码风格指南旨在让我们的 R 代码更容易阅读、分享和检查. 以下规则系与 Google 的 R 用户群体协同设计而成. R 语言是一门主要用于统计计算和绘图的高级编程语言. 这份 R 语言编码风格指南旨在让我们的 R 代码更容易阅读、分享和检查. 以下规则系与 Google 的 R 用户群体协同设计而成. ? 概要: R 编码风格约定 ? 文件命名: 以 .R (大写) 结尾 ? 标识符命名: , FunctionName, kConstantName ? 单行长度: 不超过 80 个字符 ? 缩进: 两个空格, 不使用制表符 ? 空白 ? 花括号: 前括号不折行写, 后括号独占一行 ? 赋值符号: 使用 -, 而非 = ? 分号: 不要用 ? 总体布局和顺序 ? 注释准则: 所有注释以 # 开始, 后接一个空格; 行内注释需要在 # 前加两个空格 ? 函数的定义和调用 ? 函数文档 ? 示例函数 ? TODO 书写风格: TODO(您的用户名) ? 概要: R 语言使用规则 ? attach: 避免使用 ? 函数: 错误 (error) 应当使用 stop() 抛出 ? 对象和方法: 尽可能避免使用 S4 对象和方法; 永远不要混用 S3 和 S4 ? 表示和命名 文件命名 文件名应以 .R (大写) 结尾, 文件名本身要有意义. 正例: predict_ad_revenue.R 反例: foo.R 标识符命名 在标识符中不要使用下划线 ( _ ) 或连字符 ( - ). 标识符应根据如下惯例命名. 变量名应使用点 (.) 分隔所 有的小写字母或单词; 函数名首字母大写, 不用点分隔 (所含单词首字母大写); 常数命名规则同函数, 但需 使用一个 k 开头. 正例: avg.clicks 反例: avg_Clicks , avgClicks FunctionName 正例: CalculateAvgClicks 反例: calculate_avg_clicks , calculateAvgClicks 函数命名应为动词或动词性短语. 例外: 当创建一个含类 (class) 属性的对象时, 函数名 (也是 constructor) 和类名 (class) 应当匹配 (例 如, lm). kConstantName ? 语法 单行长度 最大单行长度为 80 个字符. 缩进 使用两个空格来缩进代码. 永远不要使用制表符或混合使用二者. 例外: 当括号内发生折行时, 所折行与括号内的第一个字符对齐. 空白 在所有二元操作符 (=, +, -, -, 等等) 的两侧加上空格. 例外: 在函数调用中传递参数时 = 两边的空格可加可不加. 不可在逗号前加空格, 逗号后