java类名命名规范.doc

第 1 页共 20 页 竭诚为您提供优质文档 /双击可除 java 类名命名规范 篇一 ：java各种命名规范 定义规范的目的是为了使项目的代码样式统一，使程序 有良好的可读性。 包的命名（全部小写，由域名定义） java包的名字都是由小写单词组成。但是由于 java面 向对象编程的特性，每一名 java程序员都可以编写属于自 己的java包，为了保障每个java包命名的唯一性，在最新 的java编程规范中，要求程序员在自己定义的包的名称之 前加上唯一的前缀。由于互联网上的域名称是不会重复的， 所以程序员一般采用自己在互联网上的域名称作为自己程 序包的唯一前缀。 例如：net.frontfree.javagroup 类的命名（单词首字母大写） 根据约定，java类名通常以大写字母开头， 如果类名称 由多个单词组成，则每个单词的首字母均应为大写例如 testpage ;如果类名称中包含单词缩写， 则这个缩写词的每 个字母均应大写， 如：xmlexample,还有一点命名技巧就是 由于类是设计用来代表对象的，所以在命名类时应尽量选择 名词。 第 2 页共 20 页 例如：graphics 方法的命名（首字母小写，字母开头大写） 方法的名字的第一个单词应以小写字母作为开头，后面 的单词则用大写字母开头。例如： drawimage 常量的命名（全部大写，常加下划线） 常量的名字应该都使用大写字母，并且指出该常量完整 含义。如果一个常量名称由多个单词组成，则应该用下划线 来分割这些单词。 例如：max_Value 参数的命名 参数的命名规范和方法的命名规范相同，而且为了避免 阅读程序时造成迷惑，请在尽量保证参数名称为一个单词的 情况下使参数的命名尽可能明确。 javadoc 注释 java除了可以采用我们常见的注释方式之外， java语 言规范还定义了一种特殊的注释，也就是我们所说的 javadoc注释，它是用来记录我们代码中的 api的。javadoc 注释是一种多行注释，以/*开头，而以*/结束，注释可以 包含一些html标记符和专门的关键词。使用 javadoc注释 的好处是编写的注释可以被自动转为在线文档，省去了单独 编写程序文档的麻烦。 例如: 第 3 页共 20 页 /* *thisisanexampleof *javadoc *authordarchon *version0.1,10/11/20 xx */ 在每个程序的最开始部分，一般都用 javadoc注释对程 序的总体描述以及版权信息，之后在主程序中可以为每个类、 接口、方法、字段添加javadoc注释，每个注释的开头 部分先用一句话概括该类、接口、方法、字段所完成的 功能，这句话应单独占据一行以突出其概括作用，在这句话 后面可以跟随更加详细的描述段落。在描述性段落之后还可 以跟随一些以javadoc注释标签开头的特殊段落，例如上面 例子中的auther和version，这些段落将在生成文档中以 特定方式显示。 变量和常量命名 变量的命名 主要的的命名规范有以下三种： camel标记法：首字母是小写的，接下来的单词都以大写 字母开头第 4 页共 20 页 pascal标记法：首字母是大写的，接下来的单词都以大 写字母开头 匈牙利标记法：在以pascal标记法的变量前附加小写序 列说明该变量的类型 在java我们一般使用匈牙利标记法，基本结构为 scope_typeVariablename ，它使用1-3字符前缀来表示数据 类型，3个字符的前缀必须小写，前缀后面是由表意性强的 一个单词或多个单词组成的名字，而且每个单词的首写字母 大写，其它字母小写，这样保证了对变量名能够进行正确的 断句。例如，定义一个整形变量，用来记录文档数量： intdoccount ，其中int表明数据类型，后面为表意的 英文名，每个单词首字母大写。这样，在一个变量名就可以 反映出变量类型和变量所存储的值的意义两方面内容，这使 得代码语句可读性强、更加容易理解。 byte、int、char、 long、float 、double、boolean 和 short 。 数据类型/前缀（附） byteb charc shortsh inti longl charc strings floatf doubled hashtableh arr listlst Vectorv stringbuffersb booleanb bytebt mapmap objectob 对于在多个函数内都要使用的全局变量，在前面再增加 “g_”。例如一个全局的字符串变量： g_struserinfo 。 在变量命名时要注意以下几点： 选择有意义的名字，注意每个单词首字母要大写。 在一段函数中不使用同一个变量表示前后意义不同的 两个数值。 i、j、k等只作为小型循环的循环索引变量。 避免用Flag来命名状态变量。 用is来命名逻辑变量，如： blnFileisFound 。通过 这种给布尔变量肯定形式的命名方式，使得其它开发人员能 第 5 页共 20 页第 7 页共 20 页 够更为清楚的理解布尔变量所代表的意义。 如果需要的话，在变量最后附加计算限定词，如: cursalessum 。 命名不相包含， cursales 和 cursalessum 。 staticfinal 变量（常量）的名字应该都大写，并且指 出完整含义。 如果需要对变量名进行缩写时，一定要注意整个代码 中缩写规则的一致性。例如，如果在代码的某些区域中使用 intent ,而在另一些区域中又使用 intcount ,就会给代码增 加不必要的复杂性。建议变量名中尽量不要出现缩写。 通过在结尾处放置一个量词，就可创建更加统一的变 量，它们更容易理解，也更容易搜索。例如，请使用 strcustomerFirst 和 strcustomerlast strFirstcustomer 和 strlastcustomer 的上一个）、cur （一组变量中的当前变量）。 -为每个变量选择最佳的数据类型，这样即能减少对内 存的需求量，加快代码的执行速度，又会降低出错的可能性。 用于变量的数据类型可能会影响该变量进行计算所产生的 结果。在这种情况下，编译器不会产生运行期错误，它只是 迫使该值符合数据类型的要求。这类问题极难查找。 尽量缩小变量的作用域。如果变量的作用域大于它应 有的范围，First （一组变量中的第一个） 、last （一组变量中的最后一 个）、next （一组变量中的下一个变量） 、prev （一组变量中 ,而不要使用 。常用的量词后缀有: 第 8 页共 20 页 变量可继续存在，并且在不再需要该变量后的很 长时间内仍然占用资源。它们的主要问题是，任何类中的任 何方法都能对它们进行修改，并且很难跟踪究竟是何处进行 修改的。占用资源是作用域涉及的一个重要问题。对变量来 说， 尽量缩小作用域将会对应用程序的可靠性产生巨大的影 响。关于常量的命名方法， 在jaVa代码中，无论什么时候， 均提倡应用常量取代数字、固定字符串。也就是说，程序中 除0， 1以外，尽量不应该出现其他数字。常量可以集中在 程序开始部分定义或者更宽的作用域内，名字应该都使用大 写字母，并且指出该常量完整含义。如果一个常量名称由多 个单词组成，则应该用下划线“ _ ”来分割这些单词如： num_daysn_week、max_Value。 篇二：java各种命名规范 定义规范的目的是为了使项目的代码样式统一，使程序 有良好的可读性。 包的命名（全部小写，由域名定义） java包的名字都是由小写单词组成。但是由于 java面 向对象编程的特性，每一名 java程序员都可以编写属于自 己的java包，为了保障每个java包命名的唯一性，在最新 的java编程规范中，要求程序员在自己定义的包的名称之 前加上唯一的前缀。由于互联网上的域名称是不会重复的， 所以程序员一般采用自己在互联网上的域名称作为自己程 序包的唯一前第 9 页共 20 页 缀。 例如：net.frontfree.javagroup 类的命名（单词首字母大写） 根据约定，java类名通常以大写字母开头， 如果类名称 由多个单词组成，则每个单词的首字母均应为大写例如 testpage ;如果类名称中包含单词缩写，则这个缩写词的每 个字母均应大写，如：xmlexample,还有一点命名技巧就是 由于类是设计用来代表对象的，所以在命名类时应尽量选择 名词。 例如：graphics 方法的命名（首字母小写，字母开头大写） 方法的名字的第一个单词应以小写字母作为开头，后面 的单词则用大写字母开头。例如： drawimage 常量的命名（全部大写，常加下划线） 常量的名字应该都使用大写字母，并且指出该常量完整 含义。如果一个常量名称由多个单词组成，则应该用下划线 来分割这些单词。 例如：max_Value 参数的命名 参数的命名规范和方法的命名规范相同，而且为了避免 阅读程序时造成迷惑，请在尽量保证参数名称为一个单词的 情况下使参数的命名尽可能明确。 javadoc 注释 java除了可以采用我们常见的注释方式之外， java语 第 10 页共 20 页 言规范还定义了一种特殊的注释，也就是我们所说的 javadoc注释，它是用来记录我们代码中的 api的。javadoc 注释是一种多行注释，以/*开头，而以*/结束，注释可以 包含一些html标记符和专门的关键词。使用 javadoc注释 的好处是编写的注释可以被自动转为在线文档，省去了单独 编写程序文档的麻烦。 例如： /* *thisisanexampleof *javadoc *authordarchon *version0.1,10/11/20 xx */ 在每个程序的最开始部分，一般都用 javadoc注释对程 序的总体描述以及版权信息，之后在主程序中可以为每个类、 接口、方法、字段添加javadoc注释，每个注释的开头 部分先用一句话概括该类、接口、方法、字段所完成的 功能，这句话应单独占据一行以突出其概括作用，在这句话 后面可以跟随更加详细的描述段落。在描述性段落之后还可 以跟随一些以javadoc注释标签开头的特殊段落，例如上面 例子中的auther和version，这些段落将在生成文档中以 特定方式显示。 第 11 页共 20 页 变量和常量命名 变量的命名 主要的的命名规范有以下三种： camel标记法：首字母是小写的，接下来的单词都以大写 字母开头 pascal标记法：首字母是大写的，接下来的单词都以大 写字母开头 匈牙利标记法：在以pascal标记法的变量前附加小写序 列说明该变量的类型 在java我们一般使用匈牙利标记法，基本结构为 scope_typeVariablename ，它使用1-3字符前缀来表示数据 类型，3个字符的前缀必须小写，前缀后面是由表意性强的 一个单词或多个单词组成的名字，而且每个单词的首写字母 大写，其它字母小写，这样保证了对变量名能够进行正确的 断句。例如，定义一个整形变量，用来记录文档数量： intdoccount ，其中int表明数据类型，后面为表意的 英文名，每个单词首字母大写。这样，在一个变量名就可以 反映出变量类型和变量所存储的值的意义两方面内容，这使 得代码语句可读性强、更加容易理解。 byte、int、char、