`
dreamkid0924
  • 浏览: 12713 次
  • 性别: Icon_minigender_1
  • 来自: 石家庄
最近访客 更多访客>>
社区版块
存档分类
最新评论

java命名规范

阅读更多
  定义这个规范的目的是让项目中所有的文档看起来像是一个人写的,增加可读性,减少项目组中因为换人带来的损失。(这些规范并不是一定要绝对遵守,但是一定要让程序有良好的可读性)。
(package)包的命名
java包的名字都是由小写单词组成。但是由于java面向对象编程的特性,每一名java程序员都可以编写属于自己的java包,为了保障每个java包命名的唯一性,在最新java编程规范中,要求程序员在自己定义的包的名称前加上为的前缀。由于互联网上的域名称是不会重复的,所以程序员一般采用自己在互联网上的域名称作为自己程序包的唯一前缀。
例如: net.frontfree.javagroup

(Class)类的命名
类的名字必须由大写字母开头儿单词中的其他字母均为小写;如果类名称由多个单词组成则每个单词的首字母因为大写例如TestPage;如果类名称中包含单词缩写,则这个所写词的字母均大写XMLExample,还有一点命名技巧就是由于类是设计用来代表对象的,所以在命名类名时应尽量选择名词。
例如:Circle

方法的命名
方法的名字的第一个单词应以小写字母开头,后面的单词用大写字母开头。
例如:sendMessage

参数的命名
参数的命名和方法的命名规范相同呢,而且为了避免阅读程序时造成迷惑,请在尽量保证参数名称为一个单词的情况下使参数的命名尽可能明确;

Javadoc注释
java除了可以采用我们常见的注释方式外,java语言规范还定义了一种特殊的注释,也就是说我们所说的javadoc注释,他是用来记录我们代码中的API的。Javadoc注释是一种多行注释,一/**开头,而以*/结束,注释可以包含一些HTML标记符和专门的关键词。使用Javadoc注释的好处是编写的注释可以别自动转为在线文档,省去了单独编写程序文档的麻烦。
例如:/**
* This is an example of
* Javadoc
*
* @author darchon
* @version 0.1,10/11/2002
*/
在每个程序的最开始部分,一般都用Javadoc注释对程序的总体描述及版本信息,之后在主程序中可以为每个类、接口、方法、字段添加Javadoc注释,每个注释的开头部分先用一句话概括该类、接口、方法、字段所完成的功能,这句话应单独一行以突出其概括作用,这句话后面可以跟随更加详细的描述段落。在描述性段落之后还可以跟随一些以Javadoc注释标签开头的特殊段落,例如上面例子的@auther和@version,这些段落将在生成文档中以特定方式显示。

变量和常量命名
变量命名的方法采用匈牙利命名法,基本接口为scope_typeVariableName,它使用3字符前缀来表示数据类型,3个字符的前缀必须小写,前缀后面是由表意性强的一个单词或多个单词组成的名字,而且每个单词的首写字母大写,其他字母小写,这样保证了对变量名能够进行正确的断句。
例如定义一个整型变量,用来记录文档数量:intDocCount,其中int表明数据类型,后面为表意的英文名,每个单词首字母大写。这样,在一个变量名就可以反映出变量类型和变量所存储的值意义两方面内容,这使得代码语句可读性、更加容易理解。byte、int、char、long、float、double、boolean和short。

变量类型和首字母对照关系如下表:
数据类型/对象类型/变量前缀/备注
byte bye
char chr
float flt
boolean bln
Integer/int int
String str
single  sng
short sht
Long/long lng
Double/double dbl
Currency cur
Variantbln astr boj vnt 做布尔变量用时,用bln 做字符串数组使用时用astr,作为对象使用时,用obj,不确定时,用vnt。
对于数组在数据类型的前缀在加一个a,例如字符串数组astr。对于在多个函数内都要使用的全局变量,在前面在增加一个“g”。例如一个全局变量字符串变量:g_strUserInfo.

在变量命名时要注意以下几点:
。选择有意义的名字,注意每个单词首字母要大写。
。在一段函数中不使用同一个变量表示前后意义不同的两个数值。
。ijk等只作为小型循环的循环索引之后。
。避免用Flas来命名状态变量。
。用Is来命名逻辑变量,如blnFileIsFound。通过这种给布尔变量肯定形式的命名方式,使得其他开发人员能够更为清楚的理解布尔变量所代表的意义。
。如果需要的话,在变量最后附加计算限定词,如:curSalesSum。
。命名不相包含,如:curSales和curSalesSum。
。Static Final 变量的名字应该都大写,并且指出完整含义。
。如果需要对变量名进行缩写时,一定要注意整个代码缩写规则的一致性。例如如果在代码的某个区域中使用intCnt,而在另一个区域又使用intCount,就会给代码增加必要的复杂性。建议变量名中尽量不要出现缩写。
。通过在结尾处放置一个量词,就可以创建更加统一的变量,他们更容易理解,也更容易搜索。例如,请使用strCustomerFirst和strCustomerLast,而不要使用strFirstCustomer和strLastCustomer。常用的量词后缀有:First、Last、Next、Prev、Cur。
。为每个变量选择最佳的数据类型,这样既能减少对内存的需求量,加快代码的执行速度,又会降低出错的可能性。用于变量的数据类型可能会影响该变量进行计算所产生的结果。在这种情况下,编译器不会才产生运行期错误,它只是迫使该值符合数据类型的要求。这类问题极难查找。
。尽量缩小变量的作用域。如果变量的作用域打渔它应有的范围,变量可继续存在,并且在不在需要该变量后的很长时间内仍然占用资源。他们的主要问题是,任何类中的任何方法都能对他们进行修改,并且很难跟踪究竟是何处 进行修改的。占用资源是作用域涉及的一个重要问题。对变量来说,尽量缩小作用域将会对应用程序的可靠性产生巨大的影响。
。关于偿命的命名方法,在java代码中,无论什么时候,均提倡应用常量取代数字、固定字符串。也就是说,程序中除1.0以外,尽量不应该出现数字。常量可以集中在程序开始部分定义或者更宽的作用域内,名字应该都是用大写字母,并且指出该常量完整含义。
如果 一个常量名称由多个单词组成,则应该用下划线“_”来分隔这些单词如:
NUM_DAYS_IN_WEEK、MAX_VALUE.

推荐的命名
。类名推荐
当要区别接口和实现类的时候,可以在类的后面加上"Impl".例如:interface Container,class ContainerImpl
class Container3PImpl
class ContainerYICTImpl

。Exception类名推荐
Exception类最好能用“Exception”作为类命名的结尾。例如:
DataNotFounException
InvalidArgumentException
。抽象类名推荐
抽象类最好能用"Abstract"作为类名的开头。例如:
AbstractBeanDefinition
AbstractBeanFactory
。Test类名推荐
Test类最好能用“Test”作为类命名的结尾,例如:
ContainerTest
。工厂类方法推荐
工厂方法最好把该方法做要创建对象类型描述出来。例如:
public  Container createContainer();
public Lacation newLocation();
.虽然为一个设计低劣的程序添加注释不会使其变成好的程序,但是如果按照变成规范编写程序并且为程序添加良好的注释却可以帮你编写出设计完美、运行效率高且易于理解的程序,尤其是在多人合作完成同一项目时编程规范变得更加重要。俗话说“磨刀不误砍柴工”,花费一点时间去适应一下java编程规范是有好处的。
分享到:
评论

相关推荐

    Java命名规范 Java命名规范

    Java命名规范是编程实践中至关重要的指导原则,旨在提高代码的可读性和一致性。遵循这些规范,可以帮助团队成员更好地理解和维护代码,减少误解和错误。以下是Java命名规范的主要方面: 1. **包(Package)**: 包名...

    java命名规范 一些详细

    ### Java命名规范详解 在Java开发过程中,遵循一套合理的命名规范不仅能够提高代码的可读性和可维护性,还能帮助团队成员更快地理解和协作。本文将详细介绍Java中的命名规范,并结合给定的部分内容来具体说明。 ##...

    java命名规则

    Java编程语言以其严谨的规范和良好的可读性著称...Java命名规范是编程实践中的一项基本准则,遵守这些规则可以使代码更易于理解和维护,也利于团队间的合作。熟练掌握并应用这些规范,将有助于提升编程效率和代码质量。

    java关键字和java命名规范

    主要介绍java关键字和java命名规范,主要介绍java关键字和java命名规范

    Java命名规范

    Java命名规范是为了确保代码的可读性和一致性而制定的一套规则。遵循这些规范有助于提升团队合作效率,减少因命名不一致导致的理解障碍。本文将详细介绍Java中的几种主要命名规范及其背后的逻辑。 #### 二、包的...

    java命名规范分享

    以下是一些主要的Java命名规则: 1. **包名**: - 包名应全部使用小写字母。 - 通常,包名会基于组织的反向域名,例如`com.example.myapp`,其中`com`代表顶级域名,`example`是组织名,`myapp`是应用程序或项目...

    JAVA命名规范.pdf

    以下是一些主要的Java命名规则: 1. **包(Package)的命名**: 包名应该全部采用小写字母,由多个单词组成时,单词之间用点分隔。例如,`com.neu.util`。这种命名方式遵循了域反向工程的原则,通常使用公司或组织...

    java基础考试题【关于java命名规范的知识】

    Java命名规范是编程的基础,它有助于提高代码的可读性和一致性。以下是对Java命名规则的详细解释: 1. 类名:类名应该使用驼峰命名法(CamelCase),即每个单词的首字母大写,如选项A的`XxxYyy`。这是Java中表示类...

    java 命名规范

    在Java编程语言中,命名规范是非常重要的,它不仅...虽然没有提供具体内容,但这些主题对于深入理解和应用Java命名规范同样至关重要。阅读华为培训资料.pdf文件,可能能获取更多关于命名规范以及与IT相关的实用知识。

    java命名规范java的命名规范java的命名规范java的命名规范

    以下是根据提供的信息详细阐述的Java命名规范: 1. **文件名与类名**:公共类(`public`)的文件名必须与类名完全一致,包括大小写。例如,`public class SampleClass` 应保存在 `SampleClass.java` 文件中。非公共...

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

    Java命名规范是Java社区制定的一系列约定,用于指导开发者如何为类、方法、变量等命名,以提高代码的可读性和可维护性。以下是常用的Java命名规范: 1. 类和接口的命名:应该用名词或名词短语来命名,并且每个单词...

    C#、java命名规则和开发习惯

    这里我们将深入探讨C#和Java这两种广泛使用的编程语言的命名规范和最佳实践。 首先,让我们关注C#的命名规则: 1. 类型(类、接口等)的命名应使用PascalCase,例如`TextBox`和`ICompare`。 2. 局部变量和方法参数...

    JAVA编程命名规范Java-开发命名规范

    JAVA命名规范是JAVA开发中非常重要的一部分,它规定了JAVA程序中的命名规则,以提高代码的可读性和可维护性。该规范涵盖了JAVA中的各种命名规则,包括包命名、类命名、方法命名、参数命名、变量命名和常量命名等。 ...

    java命名规范以及注释规范

    Java编程语言有着严格的命名规范和注释规则,这对于提高代码的可读性、可维护性和团队协作至关重要。以下是对这些规范的详细说明: 1. **包名命名规范**: - 包名全由小写字母组成,可以包含少量数字。 - Java...

    java代码命名规范

    java代码命名规范

    Java命名规范.pdf

    Java 命名规范是 Java 语言中的一组约定俗成的规则,目的是为了提高程序的可读性、可维护性和可扩展性。这些规则涵盖了包、类、接口、方法、常量和变量的命名约定。 包的命名规范: * 包的名字都是由小写单词组成...

    css、js、java命名规则

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

    JAVA命名规范 编程

    【Java命名规范】是编程实践中至关重要的一环,它关乎代码的可读性和团队协作的效率。Java编程规范中,命名规则主要包括以下几个方面: 1. **包的命名**:包(Package)的名字通常由小写字母组成,为了确保唯一性,...

Global site tag (gtag.js) - Google Analytics