编程规范

在编程过程中，编写优质的代码注释对提升代码的可读性和维护性至关重要。虽然有很多资源可以帮助程序员编写更好的代码，例如书籍和静态分析工具，但针对如何编写优质注释的资源却比较少。注释的数量容易衡量，而质量则难以评估，两者之间也不一定有直接关系。实际上，糟糕的注释可能比没有注释还要糟糕。以下这些规则将帮助你在注释和代码之间找到平衡点。