美文网首页
Java项目开发命名规范

Java项目开发命名规范

作者: 尚学先生 | 来源:发表于2017-04-12 14:02 被阅读0次

最好使用英文,不要用汉语拼音

1:包(package):用于将完成不同功能的类分门别类,放在不同的目录(包)下,包的命名规则:将公司域名反转作为包名。比如www.bjpowernode.com 对于包名:每个字母都需要小写。比如:com. bjpowernode.test;该包下的Test类的全名是:com. bjpowernode.Test.java 。如果定义类的时候没有使用package,那么java就认为我们所定义的类位于默认包里面(default package)。

2:类:首字母大写,如果一个类由多个单词构成,那么每个单词的首字母都大写,而且中间不使用任何的连接符。尽量使用英文。如ConnectionFactory

3:方法:首单词全部小写,如果一个方法由多个单词构成,那么从第二个单词开始首字母大写,不使用连接符。addPerson

4:属性:与方法相同。如ageOfPerson

5:常量:所有单词的字母都是大写,如果有多个单词,那么使用下划线链接即可。

如:

【需要Java学习资料的可以加我微信领取:tangniu520666,备注“4”】

补充:在变量命名时要注意以下几点:

· 选择有意义的名字,注意每个单词首字母要大写。

· 在一段函数中不使用同一个变量表示前后意义不同的两个数值。

· i、j、k等只作为小型循环的循环索引变量。

· 避免用Flag来命名状态变量。

· 用Is来命名逻辑变量,如:blnFileIsFound。通过这种给布尔变量肯定形式的命名方式,使得其它开发人员能够更为清楚的理解布尔变量所代表的意义。

· 如果需要的话,在变量最后附加计算限定词,如:curSalesSum。

· 命名不相包含,curSales和curSalesSum。

· static final 变量(常量)的名字应该都大写,并且指出完整含义。

· 如果需要对变量名进行缩写时,一定要注意整个代码中缩写规则的一致性。例如,如果在代码的某些区域中使用intCnt,而在另一些区域中又使用intCount,就会给代码增加不必要的复杂性。建议变量名中尽量不要出现缩写。

· 通过在结尾处放置一个量词,就可创建更加统一的变量,它们更容易理解,也更容易搜索。例如,请使用 strCustomerFirst和strCustomerLast,而不要使用strFirstCustomer和strLastCustomer。常 用的量词后缀有:First(一组变量中的第一个)、Last(一组变量中的最后一个)、Next(一组变量中的下一个变量)、Prev(一组变量中的上 一个)、Cur(一组变量中的当前变量)。

· 为每个变量选择最佳的数据类型,这样即能减少对内存的需求量,加快代码的执行速度,又会降低出错的可能性。用于变量的数据类型可能会影响该变量进行计算所产生的结果。在这种情况下,编译器不会产生运行期错误,它只是迫使该值符合数据类型的要求。这类问题极难查找。

· 尽量缩小变量的作用域。如果变量的作用域大于它应有的范围,变量可继续存在,并且在不再需要该变量后的很长时间内仍然占用资源。它们的主要问题是,任何类 中的任何方法都能对它们进行修改,并且很难跟踪究竟是何处进行修改的。占用资源是作用域涉及的一个重要问题。对变量来说,尽量缩小作用域将会对应用程序的 可靠性产生巨大的影响。

关于常量的命名方法,在JAVA代码中,无论什么时候,均提倡应用常量取代数字、固定字符串。也就是 说,程序中除0,1以外,尽量不应该出现其他数字。常量可以集中在程序开始部分定义或者更宽的作用域内,名字应该都使用大写字母,并且指出该常量完整含 义。如果一个常量名称由多个单词组成,则应该用下划线“_”来分割这些单词如:NUM_DAYS_IN_WEEK、MAX_VALUE。

相关文章

  • Java项目开发命名规范

    最好使用英文,不要用汉语拼音 1:包(package):用于将完成不同功能的类分门别类,放在不同的目录(包)下,包...

  • Java 开发基础规范

    推荐 阿里巴巴 java开发手册 Java 相关命名、规范 命名:Java 类名命名(用名词性单词组合)普通类名:...

  • 系统的项目开发,其中从命名规范

    系统的项目开发,其中从命名规范

  • Java项目版本管理规范

    Java项目版本管理规范 版本命名规则 Prong Boot / Prong Cloud的版本命名规范在maven...

  • Android开发规范

    Android开发规范 一、命名规范 JAVA类和变量命名 1.命名使用英文单词拼接,驼峰命名法,不可使用拼音 2...

  • 项目开发规范参考

    现有项目的开发规范文档 目录 命名规则文件命名 HTML规范 CSS规范 JS规范变量申明简写代码性能优化注释规范...

  • Android开发规范

    一、Java语言规范 详见:Android开发java编写规范 二、Android资源文件命名与使用 1. 【推荐...

  • 2019-06-23

    # 项目开发规范 ## 编码规范 ### 命名规范 - 普通变量名一律使用小驼峰,使用匈牙利命名法,私有变量以下划...

  • Java后台开发规范

    Java后台开发规范 1.Java编程规范 1.1.命名风格 代码中的命名均不能以下划线或美元符号开始,也不能以下...

  • Web前端编码及注释规范

    一、命名规范 Web前端开发中的命名包括,项目命名、目录命名、JS文件命名、CSS文件命名、HTML文件命名等,详...

网友评论

      本文标题:Java项目开发命名规范

      本文链接:https://www.haomeiwen.com/subject/qxdmattx.html