文档介绍:该【java命名如何规范 】是由【知识徜徉土豆】上传分享,文档一共【8】页,该文档可以免费在线阅读,需要了解更多关于【java命名如何规范 】的内容,可以使用淘豆网的站内搜索功能,选择自己适合的文档,以下文字是截取该文章内的部分文字,如需要获得完整电子版,请下载此文档到您的设备,方便您编辑和打印。java命名如何规范
java命名如何规范
java定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失。以下是为大家搜索整理java命名如何规范,希望能给大家带来帮助!更多出色内容请及时关注我们应届毕业生考试网!
一、命名规范
1、 项目名全部小写
2、 包名全部小写
3、 类名首字母大写,如果类名由多个单词组成,每个单词的首字母都要大写。
如:public class MyFirstClass{}
4、 变量名、方法名首字母小写,如果名称由多个单词组成,每个单词的首字母都要大写。
如:int index=0;
public void toString(){}
5、 常量名全部大写
如:public static final String GAME_COLOR='RED';
6、所有命名规则必必需遵循以下规则:
1)、名称只能由字母、数字、下划线、$符号组成
2)、不能以数字开头
3)、名称不能使用JAVA中的关键字。
4)、坚决不同意出现中文及拼音命名。
二、解释规范
1、 类解释
在每个类前面必必需加上类解释,解释模板如下:
/**
* Copyright (C), 2006-2021, ChengDu Lovo info. Co., Ltd.
* 类的`具体说明
*
* ***@author 类创建者姓名
* ***@Date 创建日期
*/
2、 属性解释
在每个属性前面必必需加上属性解释,解释模板如下:
/** 提示信息 */
private String strMsg = null;
3、 方法解释
在每个方法前面必必需加上方法解释,解释模板如下:
/**
* 类方法的具体使用说明
*
* ***@param 参数1 参数1的使用说明
* ***@return 返回结果的说明
* ***@throws 注明从此类方法中抛出异常的说明
*/
4、 构造方法解释
在每个构造方法前面必必需加上解释,解释模板如下:
/**
* 构造方法的具体使用说明
*
* ***@param 参数1 参数1的使用说明
* ***@throws 注明从此类方法中抛出异常的说明
*/
5、 方法内部解释
在方法内部使用单行或者多行解释,该解释依据实际状况添加。
如://背景颜色
Java命名规范介绍
Java命名规范介绍
Java定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失。下面是为大家搜索整理的Java命名规范介绍,希望大家能有所收获,更多出色内容请及时关注我们应届毕业生考试网!
一、(Package)包的命名
Java包的名字都是由小写单词组成。但是由于Java面向对象编程的特性,每一名Java程序员都可以编写属于自己的Java包,为了确保每个 Java包命名的唯一性,在最新的Java编程规范中,要求程序员在自己定义的包的名称之前加上唯一的前缀。由于互联网上的域名称是不会重复的,所以程序员一般采纳自己在互联网上的域名称作为自己程序包的唯一前缀。
二、(Class)类的命名
类的名字必必需由大写字母开头而单词中的其他字母均为小写;如果类名称由多个单词组成,则每个单词的首字母均应为大写例如TestPage;如果类名称中包涵单词缩写,则这个所写词的每个字母均应大写,如:XMLExample,还有一点命名技巧就是由于类是制定用来代表对象的,所以在命名类时应尽量选择名词。
例如: Circle
三、方法的命名
方法的名字的第一个单词应以小写字母作为开头,后面的单词则用大写字母开头。
例如: sendMessge
四、参数的命名
参数的命名规范和方法的命名规范相同,而且为了避免阅读程序时造成疑惑 ,请在尽量确保参数名称为一个单词的状况下使参数的命名尽可能明确。
五、Javadoc解释
Java除了可以采纳我们常见的解释方式之外,Java语言规范还定义了一种特别的解释,也就是我们所说的Javadoc解释,它是用来记录我们代码中的API的。Javadoc解释是一种多行解释,以/**开头,而以*/结束,解释可以包涵一些HTML标记符和专门的关键词。使用Javadoc 解释的好处是编写的解释可以被自动转为在线文档,省去了单独编写程序文档的麻烦。
例如:
/**
* This is an example of
* Javadoc
*
* ***@author darchon
* ***@version , 10/11/2002
*/
在每个程序的最开始部分,一般都用Javadoc解释对程序的总体描述以及版权信息,之后在主程序中可以为每个类、接口、方法、字段添加 Javadoc解释,每个解释的开头部分先用一句话概括该类、接口、方法、字段所完成的功能,这句话应单独占据一行以特别其概括作用,在这句话后面可以跟随更加具体的描述段落。在描述性段落之后还可以跟随一些以Javadoc解释标签开头的特别段落,例如上面例子中的***@auther和***@version,这些段落将在生成文档中以特定方式显示。
六、变量命名
变量命名应该采纳首字母小写,其他字母首字母大写的方式。
Static Final 变量的名字应该都大写,并且指出完整含义。
如果必需要对变量名进行缩写时,一定要注意整个代码中缩写规则的一致性。例如,如果在代码的某些区域中使用intCnt,而在另一些区域中又使用intCount,就会给代码增加不必要的复杂性。建议变量名中尽量不要出现缩写。
通过在结尾处放置一个量词,就可创建更加统一的变量,它们更容易理解,也更容易搜索。例如,请使用 strCustomerFirst和strCustomerLast,而不要使用strFirstCustomer和strLastCustomer。常用的量词后缀有:First(一组变量中的第一个)、Last(一组变量中的最后一个)、Next(一组变量中的下一个变量)、Prev(一组变量中的上一个)、Cur(一组变量中的当前变量)。
为每个变量选择最正确的'数据类型,这样即能减少对内存的必需求量,加快代码的执行速度,又会降低出错的可能性。用于变量的数据类型可能会影响该变量进行计算所产生的结果。在这种状况下,编译器不会产生运行期错误,它只是迫使该值符合数据类型的要求。这类问题极难查找。
尽量缩小变量的作用域。如果变量的作用域大于它应有的范围,变量可继续存在,并且在不再必需要该变量后的很长时间内仍然占用资源。它们的主要问题是,任何类中的任何方法都能对它们进行修改,并且很难跟踪究竟是何处进行修改的。占用资源是作用域涉及的一个重要问题。对变量来说,尽量缩小作用域将会对应用程序的可靠性产生庞大的影响。
七、关于常量的命名方法
在JAVA代码中,无论什么时候,均提倡应用常量取代数字、固定字符串。也就是说,程序中除0,1以外,尽量不应该出现其他数字。常量可以集中在程序开始部分定义或者更宽的作用域内,名字应该都使用大写字母,并且指出该常量完整含义。如果一个常量名称由多个单词组成,则应该用下划线"_'来分割这些单词如:NUM_DAYS_IN_WEEK、MAX_VALUE。
八、推举的命名
1、类名推举
当要区别接口和实现类的时候,可以在类的后面加上"Impl'。例如: interface Container ,class ContainerImpl
class Container3PImpl
class ContainerYICTImpl
2、Exception类名推举
Exception类最好能用"Exception'做为类命名的结尾。