`
zxmsammy
  • 浏览: 5235 次
  • 性别: Icon_minigender_1
  • 来自: 广州
文章分类
社区版块
存档分类
最新评论

Java开发的常见命名规则

阅读更多
由于Java面向对象编程的特性, 在命名时应尽量选择名词。
一、包命名规范。
在java开发的过程中,每名Java开发人员都可以编写属于自己的java package,为了在编写中保证每一个java package命名的唯一性,要求开发人员在自己定义的包名前加上唯一的前缀。所以多数开发人员采用自己公司的名称.项目名.模块名.*.*.*在互联网上的域名称作为自己程序包的唯一前缀。例如: com.sun.xml.*.*.*,但要是个人的项目我们又应该怎么命名呢?
    indi :
         个体项目,指个人发起,但非自己独自完成的项目,可公开或私有项目,版权主要属于发起者。
         包名为indi.发起者名.项目名.模块名*.*.*
    pers :
         个人项目,指个人发起,独自完成,可分享的项目,版权主要属于个人。
         包名为pers.个人名.项目名.模块名*.*.*
    priv :
         私有项目,指个人发起,独自完成,非公开的私人使用的项目,版权属于个人。
         包名为priv.个人名.项目名.模块名*.*.*
    另外,我为了区分团队项目和前面所说项目的区分,还有了一下扩展:
    team :
         团队项目指由团队发起,并由该团队开发的项目,版权属于该团队所有。
         包名为team.团队名.项目名.模块名*.*.*
    com :
         公司项目:由项目发起的公司所有。
         包名为com.公司名.项目名.模块名*.*.*

二、类命名规范。
类名必须使用名词,如果一个类名内含多个单词,那么各个单词第一个字母大写,后续字母小写,起伏呈驼峰状,人称驼峰式命名。给类名命名时,必须保证准确、简洁且容易理解。尽量使用完整单词,避免使用缩写词(除了大家公认的)。
2.1 类的命名
2.1.1 一般要求
1、选择有意义的名字,能快速地传达该类的用途。
2、参照java驼峰命名法,类名的首字母必须采用大写的形式,如果类名为多词组合而成的话,那么每个词的首字母必须采用大写。如:StudentAnswer.java
3、当要区别接口类和实现类的时候,可以在类的后面加上“Impl”。
如:接口类:UserInterface.java   接口实现类:UserInterfaceImpl。
4、推荐实体类没有后缀名。
2.1.2 实际应用
应用系统中经常应用分层,Dao层(数据库访问)、Service层(业务处理)、Web层(页面控制action类),每一层的类的名称尽量带上该层后缀。
1、Dao层
a、接口类:采用JavaBean+Interface+Dao的形式来定义,即,实体对象+Interface+Dao。  
如:用户对象接口类: UserInterfaceDao,其中xxx为模块名称。
b、实现类:采用JavaBean+Interface+Impl+Dao的形式来定义,即,实体对象        
+Interface+Impl+Dao。 如:用户对象实现类:UserInterfaceImplDao
2、Service层
a、接口类:采用Xxx+Interface+Service的形式来定义,即,模块+Interface+Service。    
如:用户管理接口类:UserMsgInterfaceServiec
b、实现类:采用Xxx+Interface+Impl+Service的形式来定义,即,模块+Interface+
Impl+Service。如:用户管理实现类:UserMsgInterfaceImplServiec
3、Web层(action类)
a、实现类:采用县 Xxx+Operator+Action的形式来定义,即,模块+操作+Action。如       
用户模块User+删除操作Delete+Action = UserDeleteAction
2.2 变量的命名
2.2.1 普通变量
2.2.1.1 一般要求
1、选择有意义的名字,能快速地传达该变量的用途。
2、参照java驼峰命名法,首字母以小写开头,每个单词首字母大写(第一个单词除外)。
2.2.1.2 实际应用
1、变量命名采用基本结构为typeVariableName,使用3字符前缀来表示数据类型。
例如,定义一个整形变量:intDocCount,其中int表明数据类型,后面为表意的英文名,每个单词首字母大写。
数据类型或对象类型 变量前缀 备注
Byte bye
Char chr
Float flt
Boolean bln
Integer/int              int
Short sht
Long/long lng
Double/double dbl
String str
2、做数组用时,再加前缀-a,如字符串数组:astr,
3、自定义类型的变量可以采用本身的名称,把首字母改为小写。
4、采用名称要能代表在方法中的意义。如果员工列表:employeeList。
2.2.1.3、变量使用技巧:
a、在一段函数中不使用同一个变量表示前后意义不同的两个数值。
b、除非是在循环中,否则一般不推荐使用单个字母作为变量名,i、j、k等只作为小型循环的循环索引变量。
c、避免用Flag来命名状态变量。
d、用Is来命名逻辑变量,如:blnFileIsFound。通过这种给布尔变量肯定形式的命名方式,使得其它开发人员能够更为清楚的理解布尔变量所代表的意义。 
e、如果需要对变量名进行缩写时,一定要注意整个代码中缩写规则的一致性。例如,如果在代码的某些区域中使用intCnt,而在另一些区域中又使用intCount,就会给代码增加不必要的复杂性。建议变量名中尽量不要出现缩写。  
2.2.2 静态变量
1、选择有意义的名字,能快速地传达该变量的用途。
2、参照java驼峰命名法,采用全部大写的形式来书写,对于采用多词合成的变量采用“_”来连接各单词。如:USER_LIST
2.3 方法的命名
2.3.1 一般要求
1、选择有意义的名字,能快速地传达该方法的用途。
2、参照java驼峰命名法,首字母以小写开头,每个单词首字母大写(第一个单词除外)。
2.3.2 实际应用
1、方法表示一种行为,它代表一种动作,最好是一个动词或者动词词组或者第一个单词为一个动词。
2、属性方法:以get/set开头,其后跟字段名称,字段名称首字母大写。如:getUserName()
3、数据层方法:只能以insert(插入),delete(删除),update(更新),select(查找),count(统计)开头,其他层方法避免以这个5个单词开头,以免造成误解。
4、服务层方法,根据方法的行为命名,只描述方法的意义,而不采用方法的目的命名。比如系统的添加新用户,用户可以前台注册,也可以管理员后台添加,方法会被重用,所以最好不要用使用register,采用add会更好写。避免使用与web层相关的方法。
5、Web层方法最好是贴近web的语言,如register,login,logout等方法。

三、注释书写规范。
Java除了可以采用我们常见的注释方式(//、/* */)之外,Java语言规范还定义了一种特殊的注释,也就是我们所说的Javadoc注释,以/**开头,而以*/结束, Javadoc 注释可以被自动转为在线文档,省去了单独编写程序文档的麻烦。 推荐使用。
Javadoc注释主要涉及范围:类、属性、方法。


分享到:
评论

相关推荐

    java常见编程及命名规范

    Java编程及命名规范是软件开发中的重要组成部分,它旨在提高代码的可读性、可维护性和团队协作效率。以下是对这些规范的详细说明: 一、Java编程规范 1. **编码字符集**: Java源代码应使用UTF-8编码,确保在不同...

    Java标识符和变量的命名规则(2)

    ### Java标识符和变量的命名规则详解 #### 一、Java标识符的使用规范 在Java编程语言中,标识符是用于定义类名、方法名、变量名等的基本元素。理解并正确应用标识符的使用规范对于编写清晰、可读性强的代码至关...

    JAVA开发规范,开发注意事项

    在Java开发过程中,遵循一套规范和注意事项至关重要,它不仅能提高代码的可读性和维护性,还能确保团队间的协作效率。以下是一些核心的Java开发规范和需要注意的事项: 1. **命名规范**: - 类名:使用驼峰式命名...

    Java开发规范.docx

    Java 开发规范强调代码中的命名不能以下划线或美元符号开始,也不能以下划线或美元符号结束。同时,代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。 2. 类名使用 UpperCamelCase 风格,但...

    Java软件开发文档代码规范

    注解在Java开发中起着重要的沟通作用,它帮助开发者理解和维护代码。以下是Java中常见的注解规则: 1. Java的注释分为单行注释(//)、多行注释(/**/)以及文档注释(/**/,用于生成javadoc)。 2. 注释应简单明了...

    Java开发规范脑图|java开发规范思维导图.zip

    Java开发规范是编程实践中至关重要的一个方面,它旨在提高代码质量、可读性、可维护性和团队协作效率。本资源包含一个"Java开发规范思维导图",由"小小鱼儿小小林"创建,采用xmind工具制作,允许进一步编辑和修改。...

    java关键字和java命名规范.pdf

    5. 参数的命名:应该简洁明了,以小写字母开头,遵循变量命名规则,例如`index`、`item`。 6. 避免使用缩写:除非是广泛接受的缩写,否则应该避免使用缩写,以保证命名的清晰性。 遵循Java命名规范不仅可以使代码...

    编写代码命名规范

    在程序开发过程中,命名规则的选择对于提高代码的可读性和维护性至关重要。匈牙利命名法强调通过前缀明确变量属性,适合于早期Windows编程环境;骆驼命名法和帕斯卡命名法则更注重代码的简洁性和现代编程风格。随着...

    java项目开发常见问题分析

    总结来说,Java项目开发中的常见问题涉及多个层面,从基本的编码规范到复杂的性能优化,再到框架的熟练运用。开发者需要不断学习和实践,以提升个人技能,减少问题的发生,从而提高项目的成功率和质量。通过规范的...

    阿里巴巴Java开发规范(正式版)

    1. **命名规范**:Java编程中的命名规则是非常重要的,它直接影响代码的可读性和可维护性。阿里巴巴规范建议使用有意义的英文单词或缩写,驼峰式命名法,以及遵循特定类型的命名约定,如类名全大写,变量名首字母...

    Java开发规范(编程风格).rar

    Java开发规范,作为一门广泛应用的编程语言,其编程风格的重要性不言而喻。这份名为"Java开发规范(编程风格)"的资源,旨在为Java开发者提供一套标准和指导原则,以提高代码的可读性、可维护性和团队协作效率。这份...

    苍穹开发命名规范.pdf

    该规范适用于Java开发环境,并且覆盖了从项目命名到具体类命名等各个方面。 ##### 1.1 命名规则: **书写格式:** `<产品云代号>­<系统代号>­<工程类型>` - **产品云代号:** 代表产品的开发代号,例如“bos”...

    Java开发手册(终极版、华山版、泰山版).zip

    Java开发手册是Java开发者的重要参考资料,它包含了编程规范、最佳实践和常见问题的解决方案。这份压缩包中的"Java开发手册(终极版、华山版、泰山版).zip"提供了不同版本的阿里巴巴Java开发手册,这些版本分别代表...

    css、js、java命名规则

    ### CSS、JS、Java 命名规则 在软件开发过程中,良好的命名习惯不仅能够提高代码的可读性,还能方便团队成员之间的沟通与协作。本文将详细介绍在页面切图、程序编程、JavaScript命名等方面的常见规则及最佳实践。 ...

    java开发手册.docx

    1. **Java开发最佳实践**:手册详细介绍了在Java编程中应遵循的最佳实践,包括代码组织结构、命名规范、异常处理、内存管理等多个方面。这些最佳实践旨在提高代码可读性、可维护性和性能,使项目更加稳定可靠。 2. ...

    java/c#/js编程命名规范

    本文将深入探讨几种常见的编程命名规范,包括骆驼命名法、帕斯卡命名法、匈牙利命名法以及接口类命名规则,这些规范在Java、C#、JavaScript等主流编程语言中被广泛采用。 ### 骆驼命名法 骆驼命名法分为小驼峰命名...

    《Java开发手册(嵩山版)》.pdf

    命名规则包括但不限于类名、方法名、变量名的驼峰式命名,常量全大写并用下划线分隔,以及避免使用拼音和英文缩写,以确保代码的国际化和理解性。 常量定义部分,手册推荐使用常量池和枚举类型,避免直接使用final ...

    Java开发手册1.7.0

    Java 开发手册 1.7.0 《Java 开发手册 1.7.0》是阿里巴巴集团技术团队的集体智慧结晶和经验总结,旨在提高 Java 开发者的综合素质和软件开发质量。手册共分为七个维度:编程规约、异常日志、单元测试、安全规约、...

    java开发文档模板哦

    编码规范涵盖了命名规则(如类、接口、变量的命名)、注释的编写、代码格式化(缩进、空格、换行)等方面。遵循良好的编码规范可以减少误解,提高代码质量,使团队成员更容易理解他人的代码。例如,阿里巴巴的Java...

Global site tag (gtag.js) - Google Analytics