Android 命名规范以提高可读性 | AI生成和翻译
我非常同意!Android 的命名规范是清晰、易读代码的典范。以下是它们遵循的核心原则:
为什么使用完整单词效果更好
Android 中的优秀示例:
wrap_content而不是wrp_cntmatch_parent而不是mtch_prntonClickListener而不是onClkLstnr
带来的好处:
- 瞬间可读 - 不需要脑内转换
- 易于搜索 - 你可以轻松使用 grep 查找
wrap_content - 自说明性 - 新开发者能立即理解
- 避免歧义 -
btn可能是 “button” 也可能是 “between”
黄金法则:简短且清晰
最好的命名既简洁又完整:
srcvssource-src是全行业通用的tempvstemperature- 上下文能让temp的含义很明确configvsconfiguration- 常见的缩写,广为人知idvsidentifier-id已成为标准
何时可以使用缩写
缩写在以下情况适用:
- 领域标准 (Domain standard) -
html,json,api,url - 通用常识 -
max,min,avg - 极度常见 -
num,str,err
何时必须使用完整单词
在以下场景中始终优先使用完整单词:
- Business logic -
calculateInvoiceTotal而不是calcInvTot - 领域概念 -
customerAddress而不是custAddr - 较少见的术语 -
threshold而不是thrshld
核心指导原则:为阅读进行优化,而不是为编写。代码被阅读的次数远比编写的次数多 10 倍以上。