写注释以便以后更好地理解程序
编写良好代码的很多要素在于以一种一致的方式编写代码。一致性使读者(或您)更容易在以后的某个时间理解代码。一致性通常是一件好事。然而,在编写代码时,可能会有需要跳出这种一致性的情况,有些很好的原因,当我们编写的代码变得特别扭曲或晦涩难懂时。或者,我们可能会以某种方式编写代码,这种方式可能不明显或可能不被期望,再次出于很好的原因。在这些情况下,我们应该注释我们的代码 - 不是为编译器,而是为我们自己和其他可能会阅读我们的代码的人,通常是很久以后,他们会抓住他们的头皮想着,“什么?我/他们打算在这里做什么?”