15 个变量和方法命名的最佳实践
1、在每個(gè)代碼范圍內(nèi)使用足夠短和足夠長(zhǎng)的名稱(chēng):例如循環(huán)計(jì)算器用一個(gè)字符就可以了,如i;條件和循環(huán)變量用一個(gè)單詞,方法名1-2個(gè)單詞,類(lèi)名2-3個(gè)單詞,全局變量3-4個(gè)單詞組成
2、為變量指定一些專(zhuān)門(mén)名稱(chēng),不要使用例如 “value”, “equals”, “data” 這樣的變量名
3、變量名要使用有意義的名稱(chēng),通過(guò)變量名能大概反映出其具體的用途
4、不要在變量名前加前綴,例如 o_, obj_, m_ 之類(lèi)
5、服從公司命名規(guī)范,在命名時(shí)使用一致的做法,例如:txtUserName、lblUserName、cmbSchoolType, … 除非是大大降低了可讀性
6、服從編程語(yǔ)言本身的規(guī)范,不要使用不連貫的小寫(xiě)和大寫(xiě)混合名稱(chēng),例如:userName、 UserName、 USER_NAME、m_userName、 username, …
▲對(duì) Java 而言:
▲類(lèi)名使用駝峰命名方式,如:VelocityResponseWriter
▲包名小寫(xiě):com.jobbole.project.ui
▲變量名小寫(xiě)開(kāi)始的駝峰命名,例如:studentParentName
▲常量名用全大寫(xiě):MAX_PARAMETER_COUNT = 100
▲枚舉類(lèi)名參考普通類(lèi)名,枚舉變量使用全大寫(xiě)
▲不使用任何帶下劃線的命名方式,除非是常量或者是枚舉值
7、不要在同一個(gè)類(lèi)的不同上下文中重用相同的變量名
8、不要在一個(gè)方法內(nèi)用同一個(gè)變量做不同的用途
9、不要使用非 ASCII 字符的變量,例如中文變量
10、不要使用太長(zhǎng)的變量名,例如50個(gè)字符,這很難閱讀,而且可能超出一些編譯器的限制
11、確定并堅(jiān)持使用固定的一種自然語(yǔ)言的命名方式,例如不要使用拼音和英文混合的命名方式
12、方法名要使用有意義的名稱(chēng),能通過(guò)方法名大概了解該方法的用途,而且方法名要以動(dòng)詞開(kāi)始,例如createPasswordHash
13、方法名要符合公司統(tǒng)一的規(guī)范,例如:getTxtUserName(), getLblUserName(), isStudentApproved()
14、方法名要遵循編程語(yǔ)言規(guī)范
15、方法的參數(shù)名要使用有意義的名稱(chēng)
http://blog.jobbole.com/13593/
轉(zhuǎn)載于:https://www.cnblogs.com/code-style/p/3410583.html
總結(jié)
以上是生活随笔為你收集整理的15 个变量和方法命名的最佳实践的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問(wèn)題。
- 上一篇: android 下的网络图片加载
- 下一篇: 寻找实力高手长期合作