15 個變數和方法命名的最佳實踐

發表於2012-02-22

英文原文: codebuild,翻譯:oschina

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, …

▲對 Java 而言:

▲類名使用駝峰命名方式,如:VelocityResponseWriter

▲包名小寫:com.jobbole.project.ui

▲變數名小寫開始的駝峰命名,例如:studentParentName

▲常量名用全大寫:MAX_PARAMETER_COUNT = 100

▲列舉類名參考普通類名,列舉變數使用全大寫

▲不使用任何帶下劃線的命名方式,除非是常量或者是列舉值

7、不要在同一個類的不同上下文中重用相同的變數名

8、不要在一個方法內用同一個變數做不同的用途

9、不要使用非 ASCII 字元的變數,例如中文變數

10、不要使用太長的變數名,例如50個字元,這很難閱讀,而且可能超出一些編譯器的限制

11、確定並堅持使用固定的一種自然語言的命名方式,例如不要使用拼音和英文混合的命名方式

12、方法名要使用有意義的名稱,能通過方法名大概瞭解該方法的用途,而且方法名要以動詞開始,例如createPasswordHash

13、方法名要符合公司統一的規範,例如:getTxtUserName(), getLblUserName(), isStudentApproved()

14、方法名要遵循程式語言規範

15、方法的引數名要使用有意義的名稱

 

相關文章