Google's R Style Guide

• 语言: 英语
• 格式: .pdf
• 来源: github.com/fgaray

摘要

文档详细介绍了Google的R编程风格指南，旨在提高R代码的可读性、一致性和可维护性。指南涵盖了文件命名、代码结构、标识符命名、注释规范、语句分号的使用、函数定义与调用、对象与方法的使用、错误处理以及代码组织等方面。具体内容包括避免使用attach函数、错误处理应使用stop函数、避免混合S3和S4对象、代码行长度不超过80字符、缩进使用两个空格、注释以#开头并遵循特定格式等。

AI总结

# Google R 编程风格指南总结

## 核心观点与关键信息

### 1. **文件命名**
- 文件名必须以 `.R` 结尾。
- 文件名应简洁且有意义。

### 2. **命名约定**
- **变量名**: 使用小写字母和单词间的点号分隔（如 `variable.name`），避免使用下划线或连字符。
- **函数名**: 首字母大写，无点号（如 `FunctionName`）。
- **常量名**: 以 `k` 开头，首字母大写（如 `kConstantName`）。

### 3. **代码格式**
- **缩进**: 使用两个空格，避免使用制表符。
- **行长**: 最大不超过 80 个字符。
- **括号对齐**: 在括号内换行时，对齐括号内的第一个字符。

### 4. **注释**
- 每行注释以 `#` 开头，后面跟一个空格。
- 行内注释需在代码后保留两个空格，再跟 `#` 和内容。

### 5. **控制结构**
- **if-else 语句**: 建议使用大括号包裹 `else`。
- **避免单行 if 语句**:

  if (condition) {
    one or more lines
  } else {
    one or more lines
  }

### 6. **赋值与语句**
- 使用 `<-` 而不是 `=` 进行赋值。
- 不使用分号 `;` 终止语句或在同一行执行多个命令。

### 7. **错误处理**
- 使用 `stop()` 抛出错误，而不是简单的 `return()` 或 `print()`。

### 8. **对象与方法**
- 尽量避免使用 S4 对象和方法，优先使用 S3。
- 不要混合 S3 和 S4 对象。

### 9. **代码组织**
- 按以下顺序组织代码：
1. 版权声明
2. 作者信息
3. 文件描述
4. 库加载
5. 函数定义
6. 执行语句
- 单元测试应放在单独文件中，命名格式为 `originalfilename_test.R`。

### 10. **TODO 格式**
- 使用统一格式：`TODO(username): 描述待完成任务`。

### 11. **其他建议**
- 避免使用 `attach()`，因为它容易引发错误。
- 避免在括号内使用多余的空格，但要在逗号后保留空格。
- 避免在函数调用前使用空格，例如 `if (condition)` 是正确的，`if(condition)` 是错误的。

### 12. **通用原则**
- 保持一致性，参考团队或项目中现有的代码风格。
- 使用常识，确保代码易于理解。

通过遵循这些规则，可以提高代码的可读性、一致性和可维护性。