Google's R Style Guide

《Google's R Style Guide》是一份为提升R语言代码可读性、可共享性和可验证性而制定的编码风格指南。以下是文档的核心内容总结： ### 文件命名与结构 - 文件名应以`.R`结尾，并具有明确的意义。 - 文件结构应当包含：版权声明、作者信息、文件描述（包括程序目的、输入输出）、`source()`和`library()`语句、函数定义、执行语句等。 - 单元测试应放置在以`_test.R`结尾的独立文件中。 ### 代码布局与格式 1. **行长度**：每行代码不超过80字符。 2. **缩进**：使用两个空格缩进，禁止使用制表符。 3. **空格**：运算符、括号后应留有空格；函数调用中，函数名与括号间无空格。 4. **大括号**：若语句包含多行，左大括号与前一行内容在同一行，右大括号单独成行。 5. **分号**：禁止使用分号结束语句或在一行中写入多条命令。 6. **赋值操作符**：使用`<-`而非`=`进行赋值。 ### 注释指南 - 注释行以`#`开头，后加一个空格。 - 行内注释需在代码之后留两个空格，再加`#`和一个空格。 - 注释应清晰说明代码功能和目的。 ### 函数与错误处理 - **函数定义**：函数名首字母大写，且为动词（如`CalculateAvgClicks`）。 - **函数文档**：需包含函数目的、参数、返回值等信息。 - **错误处理**：使用`stop()`抛出错误，提示信息应清晰。 ### 语言规则 1. **标识符命名**： - 变量名：推荐使用小写字母和点号分隔（如`variable.name`），也接受驼峰式（`variableName`）。 - 函数名：首字母大写，不用点号（如`FunctionName`）。 - 常量名：以`k`开头，首字母大写（如`kConstantName`）。 2. **避免使用`attach()`**：使用`attach()`可能导致错误，建议避免。 3. **对象与方法**：尽量使用S3对象和方法，避免混合使用S3和S4。 ### 风格一致性 - 遵循全局风格规则，同时尊重局部代码风格，以保持代码的连贯性。 - TODO格式统一：`TODO(username)`，后接具体说明。 ### 例外与参考 - 例外包括旧代码和第三方代码的修改。 - 参考资源：R Coding Conventions、Emacs R模式等。 这份指南的目的是帮助开发者编写更加规范、易读和易于协作的R代码。通过遵循这些规则，可以减少代码阅读的障碍，让团队更专注于代码的核心功能。