15個變量和方法命名的最佳實踐
2012-02-21 17:33:04來源：codebuild作者：
在每個代碼范圍內使用足夠短和足夠長的名稱：例如循環計算器用一個字符就可以了，如i；條件和循環變量用一個單詞，方法名1-2個單詞，類名2-3個單詞，全局變量3-4個單詞組成
為變量指定一些專門名稱，不要使
- 在每個代碼范圍內使用足夠短和足夠長的名稱：例如循環計算器用一個字符就可以了，如i；條件和循環變量用一個單詞，方法名1-2個單詞，類名2-3個單詞，全局變量3-4個單詞組成
- 為變量指定一些專門名稱，不要使用例如 "value", "equals", "data" 這樣的變量名
- 變量名要使用有意義的名稱，通過變量名能大概反映出其具體的用途
- 不要在變量名前加前綴，例如 o_, obj_, m_ 之類
- 服從公司命名規范，在命名時使用一致的做法，例如：txtUserName, lblUserName, cmbSchoolType, ... 除非是大大降低了可讀性
- 服從編程語言本身的規范，不要使用不連貫的小寫和大寫混合名稱，例如：userName, UserName, USER_NAME, m_userName, username, ...
- 類名使用駝峰命名方式，如：VelocityResponseWriter
- 包名小寫：net.oschina.beans.xxx
- 變量名小寫開始的駝峰命名，例如：studentParentName
- 常量名用全大寫：MAX_PARAMETER_COUNT = 100
- 枚舉類名參考普通類名，枚舉變量使用全大寫
- 不使用任何帶下劃線的命名方式（OSCHINA項目大量采用帶下劃線的變量，哈哈），除非是常量或者是枚舉值
- 不要在同一個類的不同上下文中重用相同的變量名
- 不要在一個方法內用同一個變量做不同的用途
- 不要使用非 ASCII 字符的變量，例如中文變量
- 不要使用太長的變量名，例如50個字符，這很難閱讀，而且可能超出一些編譯器的限制
- 確定并堅持使用固定的一種自然語言的命名方式，例如不要使用拼音和英文混合的命名方式
- 方法名要使用有意義的名稱，能通過方法名大概了解該方法的用途，而且方法名要以動詞開始，例如createPasswordHash
- 方法名要符合公司統一的規范，例如：getTxtUserName(), getLblUserName(), isStudentApproved()
- 方法名要遵循編程語言規范
- 方法的參數名要使用有意義的名稱
