提升编程质量：GitHub上的‘垃圾代码’准则指南

在本文档中，我们探讨了"垃圾代码书写准则"这一主题，它源于GitHub上一个有趣的项目，旨在通过反面例子强调编写高质量、可读性强的代码的重要性。作者trekhleb以JavaScript代码为基础，将其转换成Java版本，并提供了中文翻译，以帮助开发者理解和遵循良好的编程习惯。 首先，关于变量命名，作者指出应避免使用过于简短或容易引起混淆的名称。例如，"inta=42"是好的命名，而"intintage=42"则显得难以理解。推荐的实践是保持一致性，如"intwindowWidth"和"intwindowHeight"，尽管它们稍微冗长但更清晰。 其次，注释的作用不可忽视。"Good"的示例中，注释应解释代码的目的而非仅仅说明事实，如`//700ms的数量是从UXA/B测试结果中得到的一个经验值`。反之，"Bad"的注释如`//隐藏错误弹窗`只表达了动作，没有说明原因。提倡提供具有上下文的注释，帮助他人理解你的逻辑。 语言选择也是一个重要因素，特别是对于本地化的代码。使用母语进行注释有助于传达意图，如`//Закриваємомодальневіконечkopривиникненніpомилки`，即使对非母语读者可能不够直观。 此外，变量声明的风格应当统一，避免像`String[]i1`和`Stringi2[]`这样的混乱，推荐的做法是`String[]wanger`和`Stringwangsan[]`虽然形式不同，但至少在长度上保持一致。 最后，虽然有时追求简洁，但过度压缩代码可能导致理解困难，如将循环和打印操作合并到一行`IntStream.range(1,5).boxed().map(i->{System.out.print("HappyBirthday")}`。理想情况下，代码应保持清晰，易于阅读。 这篇文档强调了代码清晰度、一致性、注释质量和适当的语言选择在编写代码中的关键作用，以避免产生所谓的"垃圾代码"，从而提升代码的可维护性和团队协作效率。遵循这些准则，开发者可以创建出更高效、更易理解的代码库。