Java基础之命名规范

一 命名规则

1)包: 命名应该都是名词或名词性词组,全部小写,单词之间用“.”分开,一般使用本公司网站域名的逆序后跟具体的软件内部模块名

包命名举例: package com.sun.java; package com.baidu.java;

2)类: 名词或名词性词组,每个单词首字母大写;一般不使用缩写,除非其缩写更通用和便于理解,大驼峰命名法,每一个单字的首字母都采用大写字母,如HTML;当要区别接口和实现类的时候,可以在类的后面加上"Impl",例如:interface Container与class ContainerImpl;Exception类用"Exception"做为类命名的结尾,例如:DataNotFoundException;抽象类用"Abstract"做为类命名的开头,例如:AbstractBeanDefinition,AbstractBeanFactory;Test类最好能用"Test"做为类命名的结尾。例如:ContainerTest

类命名举例:class Person; class SpringRain

3)接口: 同"类"的命名规则

接口命名举例:interface Runner;

4)方法: 动词或动词性词组,首字母小写,第二个及以后的单词首字母大写,小驼峰命名法,第一个单字以小写字母开始,第二个单字的首字母大写;

方法命名举例:run(); displayInformation();

5)变量: 名词或名词性词组,首字母小写,第二个及以后的单词首字母大写;

不提倡使用下画线"_“和美元符”$"作为变量开头;单词间可以使用下画线分隔;变量名不宜过长但也应有意义,除非是临时使用(例如只涉及几行代码)后即丢弃的情况,不建议使用单个字母做变量名,常用的临时使用的变量名包括表示整数的i,j,k,m,n和表示字母的c以及表示异常对象的e等。

变量命名举例:int age; int student_age; String studentName; Exception e;

6)常量: 每一个单词都要大写,单词之间用"_"分开。

常量命名举例:final static int MIN_WIDTH = 4;final static int DEFAULT_CONTAINER_SIZE = 20;

7)文件的命名: java源程序文件以.java结尾,编译后的文件以.class结尾。例如:Container.java,Container.class。

总结:类名首字母应该大写。字段、方法以及对象(句柄)的首字母应小写。对于所有标识符,其中包含的所有单词都应紧靠在一起,而且大写中间单词的首字母。若在定义中出现了常数初始化字符,则大写static final基本类型标识符中的所有字母。这样便可标志出它们属于编译期的常数。 Java包(Package)属于一种特殊情况:它们全都是小写字母,即便中间的单词亦是如此。对于域名扩展名称,如com,org,net或者edu等,全部都应小写。

二 文件组织

1. 一个文件由被空行分割而成的段落以及标识每个段落的可选注释共同组成。超过2000行的程序难以阅读,所以一个java程序文件中的代码行数不能超过2000行,除非有特殊原因。每个Java源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共类相关联,可以将它们和公共类放入同一个源文件。公共类必须是这个文件中的第一个类或接口。

Java源文件还遵循以下规则,这个规则规定了java程序段落的顺序:

  • 开头注释
  • 包和引入语句
  • 类和接口声明

2. 在一个Java类中,各部分顺序:

1)属性声明

2)构造方法声明

3)static语句

4)普通方法声明

5)main方法声明

6)内部类的声明

总结:一般一个完整的java文件内容如下:

1)包的定义

2)impot类(输入包的顺序、避免使用*)输入包应该按照java..,javax..,org.. ,com..的顺序import;在import的时候不应该使用 (例如: java.util.)

3)类或接口的定义

4)静态变量定义,按public,protected,private顺序

5)实例变量定义,按public,protected,private顺序

6)构造方法

7)方法定义顺序按照public方法(类自己的方法),实现接口的方法,重载的public方法,受保护方法,包作用域方法和私有方法。

注意:一般类中每个方法的代码行数不要超过100行。

三 分隔和缩进

1. 使用空行

在下述情况下使用单行的空白行来分隔:

1)在方法之间

2)在方法内部代码的逻辑段落小节之间

3)在方法中声明局部变量之后,具体的Java语句之前

4)在注释行之前

5)在同一个源文件中定义的多个类/接口之间使用双行的空白行来分隔

2. 使用空格符

除正常的成分之间以空格符分隔名(如数据类型和变量名之间),在下述情况下也应使用一个空格符来分隔:

1)运算符和运算符之间,如: c = a + b;

2)在参数列表中的逗号后面,如: void m1(int year, int month) {}

3)在if,for,while待语句之后 如: if (a > b) {}

3. 使用换行符

不建议在一行中写多条语句,一条语句的长度一般超过了80个字符时,应该换行;

当一行表达式不能在一行内显示,请按下列顺序要求拆行:

1)在"(“或”="符号后拆行

2)在","拆行

3)在一个操作符后拆行

4)把并发的拆行放到同一级别上的缩进

5)如果在拆行中再次拆分的时候遇到"(",应该新拆出来的行放在更远的一个缩进级别上

4. 使用小括号

可以使用小括号来强行规定运算顺序

5. 使用花括号

开始位置可以位于当前内容的尾部,也可以另起一行

6. 使用缩进

在下述情况下应用缩进

1)类中的成分

2)方法体或语句块中的成分

3)换行时的非起始行

缩减量一般为在上一级成分的基础上再缩进四个空格,而 Eclipse 默认格式化是采用 1 个制表符的,可以采用下面的方式更改一下:Window ——> Preferences…… ——> Java ——> Code Style ——> Formatter 点右边的"Edit……“按钮,切换到第一个选项卡"Indentation”,在 General settings 组将 Tab policy 由 Table only 改为 Space only,同时把 Indentation size 和 Tab size 改为 4,最后把最上面的 Profile name 取一个名字,名字任意,再点 OK 按钮就可以了。以后按 Tab 键或者 Ctrl + Shift + F 会自动采用 4 个空格作为一个层次的缩进。在eclipse开发工具中,把代码写好之后,可以用快捷键:CTRL + SHIFT + F来自动格式化代码。

四 声明语句

1. 变量声明:每行声明一个变量,并加注释。例如:

int count; // number of containers

int count, size; // AVOID THIS!

数组声明应该采用前缀方式。例如:

int[] table;

String[] args;

2. 类或接口声明

  1. "{"和声明语句在同一行。

2.如果不能在同一行显示,就将"extends"或"implements"进行拆行,并放在两个缩进级别后。

3."}"符号应该独自占一行。

例如:

public class ChiefExecutiveOfficer

extends Manager

implements Person {

}

3. 方法声明

"{"和声明语句在同一行。

"}"符号应该独自占一行。

总结:每行声明一个变量,并尽量在声明变量的同时对其进行初始化,除非其初值尚不确定。局部变量应在其所在的方法或语句块的开头集中声明,而不应随用随声明。

五 注释

Java有两种注释方法。"/* This is a comment */"或 “// This is a comment”

第一种应该被用到写JavaDoc上,并且都用"/**"开头。

第二种适合于在做部分代码的注释,但只适合做非常短内容的注释。

原文地址:https://www.cnblogs.com/CQqf/p/10836986.html

时间: 2024-10-08 00:24:45

Java基础之命名规范的相关文章

Java开发相关命名规范

JAVA文件命名规范 1.类命名 抽象类以ABstract或者Base开头.异常类以Exception结尾.枚举类以Enum作为后缀.形容能力的接口使用able作为后缀.实现类与接口用后缀Impl区别.数据类:表名+DO.传输类:领域相关名+DTO.展示类:页面名称+VO. 2.service/dao层方法命名 获取单个对象用get做前缀.获取多个对象用list做前缀获取统计值用count做前缀.插入用save做前缀.删除用remove做前缀.修改用update做前缀. 数据库命名规范 库:应用

【Java】变量命名规范

Java是一种区分字母的大小写的语言,所以我们在定义变量名的时候应该注意区分大小写的使用和一些规范,接下来我们简单的来讲讲Java语言中包.类.变量等的命名规范. (一)Package(包)的命名 Package的名字应该都是由一个小写单词组成,例如com.xuetang9.company等. (二)Class(类)的命名 Class的名字首字母大写,通常由多个单词合成一个类名,要求每个单词的首字母也要大写,例如:XueTang或ProNine. (三)变量的命名 变量的名字可大小写混用,但首字

HTML5基础CSS命名规范讲解

相信有很多HTML5全栈开发的初学者对CSS的命名规则都是一头雾水,这可不是一个好的现象,那么下面就来给大家说一下HTML5全栈开发中的命名规范,希望可以帮到各位.. CSS命名规范 全局样式命名规范:global.css; 框架布局命名规范:layout.css; 字体样式命名规范:font.css; 链接样式命名规范:link.css; 打印样式命名规范:print.css; 常用类/ID命名规范 页眉规范:header 内容规范:content 容器规范:container 页脚规范:fo

java基础---如何命名Java变量(四)

如何命名Java变量 如同酒店会给每个房间起个性化的名字一样,程序中的变量也需要用合理的名字进行管理---变量名! 需要注意,给酒店房间起名字时可以是数字,如"802",也可以是有趣的名字,如"牡丹"."美国总统"."水帘洞"等,但在给变量起名字时,必须符合一定的规则,如下所示: 以下变量的命名都是符合规范的: 但请看下面的代码,你懂得哈: 优秀攻城师的习惯: 1.变量名由多单词组成时,第一个单词的首字母小写,其后单词的首字母

Java包的命名规范

indi : 个体项目,指个人发起,但非自己独自完成的项目,可公开或私有项目,版权主要属于发起者. 包名为indi.发起者名.项目名.模块名*.*.* pers : 个人项目,指个人发起,独自完成,可分享的项目,版权主要属于个人. 包名为pers.个人名.项目名.模块名*.*.* priv : 私有项目,指个人发起,独自完成,非公开的私人使用的项目,版权属于个人. 包名为priv.个人名.项目名.模块名*.*.* team : 团队项目指由团队发起,并由该团队开发的项目,版权属于该团队所有. 包

java中的命名规范,项目开发步骤

1. 项目名:没有要求,别中文 2. 包:公司域名倒写:com.igeek 3. 持久层:dao,persist,mepper 4. 实体类:entity,model,bean,javabean,pojo 5. 业务逻辑:service 6. 控制器:controller,servlet,action,web 7. 过滤器:filter 8. 异常:exception 9. 监听器:listener 10. 注释: 类和方法上使用文档注释:/**   */ 方法里使用/*   */  或者  /

Java基础--Java编程规范

IsCoder 标记: Java基础,Java编程规范 摘要:Java虽然没有强制性的编程规范,但是为了便于统一,Java有不成文的编程规范,为了形成良好的编程习惯,建议熟悉并遵守Java编程规范,提高代码的阅读性. 一.Java标识符 在任何语言中,都要自己的一套标识符规则.Java的标识符包括:Java关键字.Java特殊功能的标识符.合法的用户自定义标识符.其中,我们能改变的只有自定义的标识符,和大部分计算机编程语言一样,Java标识符原始只支持ASCII的编码,但是随着Java在世界的影

Android开发命名规范和编码规范

转载请注明出处:http://blog.csdn.net/crazy1235/article/details/51346027 无规矩不成方圆,是吧..哈哈~~ 很庆幸,本人刚学java编程的时候,就被老师灌输了编程规范的相关知识,并且一直在遵守. 有过团队开发经验的人都知道,如果没有一定的规范可行,那么代码看起来将是苦不堪言,甚至是乱七八糟. 下面就介绍一下,我个人编码过程中使用到的规范,供大家参考~~ 命名规范 命名规范要望文知义,简单明了. 命名规范定制太多,就会让人心烦,反而没人遵守了.

java命名规范和编程技巧

一个好的java程序首先命名要规范. 命名规范 定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,方便维护等作用 Package 的命名 Package 的名字应该都是由一个小写单词组成. Class 的命名 Class 的名字必须由大写字母开头而其他字母都小写的单词组成 Class 变量的命名 变量的名字必须用一个小写字母开头,后面的单词用大写字母开头. Static Final 变量的命名  Static Final 变量的名字应该都大写,并且指出完整含义. 参数的命名