【原创】【深入浅出系列】之代码可读性
内容提要
本文讨论了代码可读性问题，提出了提高代码可读性的方法，如合理的业务逻辑抽象、职责单一、命名规范和关键注释等。作者认为代码可读性是永恒追求目标。
延伸解读
注释与代码的平衡之道
文章指出，注释并非越多越好。过度注释不仅会分散阅读注意力，还可能因代码逻辑变更而失效，带来维护负担。作者强调，好的注释应像HashMap中关于线程安全的说明那样，提供关键性、使用上需注意的信息，而非随处可见的//和/*。这提醒我们，注释的价值在于精准传达必要信息，而非数量堆砌。
抽象与职责单一：可读性的基石
作者认为，合理的业务逻辑抽象是提高可读性的基础。通过将代码按功能归类为独立方法，如示例中的initTempFilePath、findEncryptedFiles和dencryptFiles，使主方法一目了然。抽象与职责单一相辅相成：一个方法只做一件事，一个类只承担单一职责，这能缩小问题影响范围，降低维护成本。缺乏合理抽象，方法间会藕断丝连，导致一处改处处改。
命名规范：被忽视的基础功底
文章强调，命名规范虽老生常谈，但真正做到的coder不多。类名应用名词，方法名用动词，因为类表述做什么，方法表述如何做。规范的命名和正确的词法有助于他人阅读代码。作者以阅读Spring源码顺畅而读同事业务代码蹩脚为例，指出我们常过度关注Spring的IOC等高级特性，却忽略了最基础的命名功底。
Q&A
什么是代码可读性？
代码可读性是指代码的清晰程度和易于理解的特性，包括合理的业务逻辑抽象、职责单一、命名规范和关键注释等。
如何提高代码的可读性？
可以通过合理的业务逻辑抽象、确保每个方法只做一件事、遵循命名规范以及添加关键注释来提高代码的可读性。
注释在代码可读性中扮演什么角色？
注释应简洁明了，突出关键性信息，避免过度依赖注释，因为代码本身应尽量表达清晰，注释主要用于补充重要信息。
为什么要遵循命名规范？
遵循命名规范有助于提高代码可读性，类名应为名词，方法名应为动词，这样可以清晰表达代码的功能和意图。
代码可读性是一个持续追求的目标吗？
是的，代码可读性是一个持续追求的目标，随着编码经验的积累，程序员对可读性的理解会不断深化。
如何定义一个方法只做一件事？
一个方法只做一件事是指该方法应专注于完成一个特定功能，避免混合多个功能，以便于理解和维护。
