The Unofficial Ruby Usage Guide
a year ago
- #Style Guide
- #Ruby
- #Programming
- 该文档最初是为谷歌运营部门内部使用而撰写，旨在通过提供风格和使用指南来推动Ruby语言的采用。
- Ruby被强调为系统管理等任务的优秀工具，提倡使用统一的风格词汇以提升代码维护性和可读性。
- 推荐使用Interactive Ruby (irb)进行开发，其方法名自动补全和结果自动打印功能可加速编辑-运行-调试循环。
- Ruby Interactive (ri)作为类似perldoc的文档工具被引入，是访问Ruby类和方法文档的重要途径。
- Ruby调试器和性能基准测试模块分别被提及为调试和性能优化的关键工具。
- 强调使用Ruby的Test::Unit模块进行单元测试来验证代码正确性，并以Ruby/Password库中的示例说明。
- 简要提及Vim和Emacs对Ruby的编辑器支持，包括语法高亮和Vim中Ruby解释器的集成功能。
- 概述了Ruby编码的风格指南，包括代码组织、异常处理、避免全局变量以及保持缩进和空格一致的重要性。
- 鼓励使用RDoc实现代码自文档化，并提供注释技巧及RD用于页眉/页脚的建议。
- 讨论了字符串处理、运算符优先级和迭代器块语法，并推荐使用新库替代已弃用的库。
- 明确了类、模块、常量、方法和变量的命名规范，以保持Ruby代码库的一致性。
- 引入Ruby安全等级机制作为处理不可信数据时的安全增强手段，描述了四个逐级提升的安全级别。
- 文档最后提倡优先使用纯Ruby方案而非调用外部二进制程序，以避免安全、健壮性和可移植性风险，并强调编码一致性的重要性。