规约类型:编程规约 - 命名风格
规约级别:强制
规约描述:代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式
说明: 正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,即使纯拼音命名方式,也要避免采用。
正例:
alibaba / taobao / youku / hangzhou 等国际通用的名称, 可视同英文
反例:
DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量
1、如果某些变量的英文是比较冷僻的单词,也要使用英文来进行命名,同时,可以对这个变量进行一些啰嗦的注释,以便阅读代码的人能够结合注释看明白该变量;
延伸阅读:15 Best Practices of Variable & Method Naming
说明:内容摘自《阿里巴巴 Java 开发手册》,版权归手册出品团队所有。本文作者根据自己过往的编码经验,对其做一些学习纪要。免费获取规约PDF
代码检查插件:免费获取插件