关于编程命名规范的一些心得
前段时间对项目进行了命名的调整,现在分享一下学到的心得。所有的程序开发手册都包含了各种规则。一些习惯自由程序人员可能对这些规则很不适应,但是在多个开发人员共同写作的情况下,这些规则是必需的。这不仅仅是为了开发效率来考虑,而且也是为了后期维护考虑。
定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失。这些规范并不是一定要绝对遵守,即使没有遵守命名规范,程序依然可以运行,但是一定要让程序有良好的可读性,便于后期的维护管理。
java的命名
包的命名
Package(包)的名字应该都是由小写单词组成,为了保障每个Java包命名的唯一性,自己定义的包的名称之前加上唯一的前缀。由于互联网上的域名称是不会重复的,所以程序员一般采用自己在互联网上的域名称作为自己程序包的唯一前缀。
类的命名
类的名字必须由大写字母开头而单词中的其他字母均为小写;如果类名称由多个单词组成,则每个单词的首字母均应为大写例如TestDemo;如果类名称中包含单词缩写,则这个所写词的每个字母均应大写,如:XMLParser。还有一点命名技巧就是由于类是设计用来代表对象的,所以在命名类时应尽量选择名词。
方法和变量的命名
方法的和变量命名,大致一样,方法表示动作,所以取名时最好使用表示动作的单词,而变量最好使用名词,并指出完整含义。方法和变量的命名有较多的命名方法,java中比较常用的是骆驼命名法。
1,骆驼(Camel)命名法:第一个字母小写,随后的每个单词的第一个字母大写。如:projectName
2,帕斯卡(Pascal)命名法:每一个单词的第一个字母都大写。如:ProjectName 。
3,匈牙利命名法:加前缀。如btnName、formName。
4,下划线命名法:下划线命名法是通过下划线来区分变量、函数名、类名中的单词的一种方法。
参数的命名
参数的名字必须和变量的命名规范一致,而赋值方法的参数,使用有意义的参数命名,如果可能的话,使用和要赋值的字段一样的名字:
setName(String name){
this.name = name;
}
数组的命名
数组应该总是用下面的方式来命名:
byte[] buf;
而不是:
byte buf[];
虽然两者都可以编译通过,但byte[] 更能直观的体现buf的数据类型。
其他方面的命名规则
网页html和Css的命名:通常都为小写字母的单词和 – 组成,有些习惯用下划线区分,最好不使用单词的开头大写字母来区分,因为浏览器对html和css不做大小写的区分。
Need a translation service?
Please enter your personal details and we will contact you shortly
Words translated by CCJK
146,096,379Over 95% of our clients recommend our language services to others