15 个变量和方法命名的最佳实践[转]

15 个变量和方法命名的最佳实践

1. 在每个代码范围内使用足够短和足够长的名称：例如循环计算器用一个字符就可以了，如i；条件和循环变量用一个单词，方法名1-2个单词，类名2-3个单词，全局变量3-4个单词组成
2. 为变量指定一些专门名称，不要使用例如 "value", "equals", "data" 这样的变量名
3. 变量名要使用有意义的名称，通过变量名能大概反映出其具体的用途
4. 不要在变量名前加前缀，例如 o_, obj_, m_ 之类
5. 服从公司命名规范，在命名时使用一致的做法，例如：txtUserName, lblUserName, cmbSchoolType, ... 除非是大大降低了可读性
6. 服从编程语言本身的规范，不要使用不连贯的小写和大写混合名称，例如：userName, UserName, USER_NAME, m_userName, username, ...
   1.  
      • 类名使用驼峰命名方式，如：VelocityResponseWriter
      • 包名小写：net.oschina.beans.xxx
      • 变量名小写开始的驼峰命名，例如：studentParentName
      • 常量名用全大写：MAX_PARAMETER_COUNT = 100
      • 枚举类名参考普通类名，枚举变量使用全大写
      • 不使用任何带下划线的命名方式（OSCHINA项目大量采用带下划线的变量，哈哈），除非是常量或者是枚举值
   • 对 Java 而言：
7. 不要在同一个类的不同上下文中重用相同的变量名
8. 不要在一个方法内用同一个变量做不同的用途
9. 不要使用非 ASCII 字符的变量，例如中文变量
10. 不要使用太长的变量名，例如50个字符，这很难阅读，而且可能超出一些编译器的限制
11. 确定并坚持使用固定的一种自然语言的命名方式，例如不要使用拼音和英文混合的命名方式
12. 方法名要使用有意义的名称，能通过方法名大概了解该方法的用途，而且方法名要以动词开始，例如createPasswordHash
13. 方法名要符合公司统一的规范，例如：getTxtUserName(), getLblUserName(), isStudentApproved()
14. 方法名要遵循编程语言规范
15. 方法的参数名要使用有意义的名称