编写干净的代码之变量篇

摘要

代码的可读性和可维护性至关重要，尤其考虑到代码将被他人阅读和维护。本文讨论了编写「干净」代码的重要性，特别是如何命名变量以提高代码质量。

意图明显

变量名称应该清晰表达编程者的意图，易于理解。例如，使用完整的单词如teacher代替缩写如t。

使用方法而非变量

推荐使用方法来获取对象状态，而非直接访问变量，以增强代码的统一性和直观性。

避免误导性或混淆的名称

变量名称应避免使用可能造成误解的类型名称，且不应与其他变量混淆或相似，避免使用同义词。

善用IDE

利用IDE工具的自动完成功能来避免保留关键字和干扰词，使用具有明确含义的名称。

避免缩写

尽量不使用缩写，以确保所有人都能理解变量名称的含义，如使用SchoolUserBirthday而非SUB。

使变量容易搜索

变量应命名为与其功能相关，以便容易在IDE中搜索，但循环变量可以使用单个字母命名。

编码接口的实现

面向接口编程中，接口的实现应命名为类名后加上Imp。

名称应为名词或名词短语

对象和类应使用名词或名词短语命名，以代表它们要模拟的实体。

方法应为动词或动词短语

方法执行操作，故应使用动词或动词短语命名，并遵循Java Bean命名约定。

一致的名称转换

保持方法命名的一致性，但要区分不同的概念，使用专业名称，避免非专业术语。

结论

变量命名只是编写干净代码的一个方面，在确保维护者能够理解代码方面，还有更多工作要做。

本文首发于「FunTester」公众号，由原创分享爱好者撰写，并在多个社区平台推荐。