clean-code-ruby

clean-code-ruby

针对 Ruby 所调整的清晰代码概念。 受 clean-code-JavaScript 的启发。 注: 这些示例大部分来自 JavaScript, 因此可能不符合语法规范。欢迎指出任何不符合语法规范的 Ruby 代码, 我会立即更正。此外, 也欢迎提交 pull request!

目录

1. 简介
2. 变量
3. 方法
4. 对象和数据结构
5. 类
6. SOLID
7. 测试
8. 错误处理
9. 格式化
10. 注释
11. 翻译

并非每条原则都必须严格遵守,更没有哪条原则会得到普遍认同。这些都是指导原则,仅此而已,但它们是清晰代码的作者在多年集体经验中编纂的。软件工程这个行业才刚刚有50多年的历史,我们仍在不断学习。当软件架构像建筑本身一样古老时,也许我们将有更严格的规则可遵循。目前,让这些指导原则成为衡量您和您的团队所编写的 Ruby 代码质量的标准。

还有一件事：了解这些并不意味着你会立即成为一个更好的软件开发人员，而且与它们一起工作多年并不意味着你不会犯错误。每一行代码最初都是一个初稿，就像将湿泥塑造成最终形状。最后，我们在与同行进行审查时会去除不完美的部分。不要为需要改进的初稿自责。反而要对代码进行打击！