50个成为优秀程序员的法则[11-20]

这意味着你要写干净的代码，但什么才是干净的代码呢？干净的代码结构良好，排列良好。干净的代码不会隐藏错误。它向程序员公开了bug可以隐藏的任何地方，并可以无需完全重构就可以修复其中的bug。

开放-封闭原则（OCP）指出，类、方法或函数必须对扩展开放，但不能进行修改。这意味着定义的任何类、方法或函数都可以很容易地为多个实例重用或扩展，而无需更改其代码。

Liskov替换原则（LSP）是一种子类型关系的特定定义，称为强行为子类型，最初由Barbara Liskov在1987年的一次会议主题演讲中引入，题为数据抽象和层次结构。它基于“可替换性”的概念——面向对象编程中的一项原则，规定对象（如类）可以被子对象（如扩展第一类的类）替换，而不会破坏程序。它是一种语义关系，而不仅仅是句法关系，因为它旨在保证层次结构中类型的语义互操作性，尤其是对象类型。

文章中说，每当您需要使用注释时，都要为自己无法用代码表达自己而感到羞耻。但是在某些情况下，使用注释实际上有助于表达代码的底层工作原理，而不是代码本身。原文列举了几个好注释的最佳示例：

• 信息注释：例如，突出函数返回值的注释
• TODO注释
• 后果警告

• 噪声注释 ，如下：

    # add to animal list
    animal.append(dog)

• 非本地信息 ：编写注释时，确保它只与它引用的函数或语句相关。除此之外的任何内容都应该删除。
• 不明显的注释 ：你的评论和引用的函数之间的联系必须清晰。
• 短函数 ：短函数往往不需要注释，而是用一个好的名字来描述它。

出于可重用性和易读性的需要，源文件应该在100-200行之间，最多500行。除非你有很好的理由选择其他方式。

空行是告诉读者我们正在进入一个新的独立概念的一种方式。每一个代码块表示一个完整的想法。

Go where you are valued

函数/变量应该尽可能靠近最需要或最重要的地方。它应该离它最不重要的地方最远。

我们使用空格来表示两件事不是强相关的，没有空格来关联强相关的事物。

降低这些个人偏好并采用团队的偏好。