java命名规范:一些细节

java命名规范:一些细节


任何一门语言都是用来交流的,都有自己的一套书写规范,Java 也不例外。

注重这些细节有几个好处:

  1. 好的命名规范可以使得写出来的程序更容易被别人理解,更好维护。当然也易于自己理解,以便日后扩展。
  2. 同时,也使程序更规范和专业。  在这个人性化横行的今天,我们的Java命名规范也应该注重体验。
  3. 了解命名规范,可以更好的学习和记忆 Java 类库中的类和函数等。
  4. 在命名规范里有很多都涉及到英文的,可以促进英文学习。

比如: numberMax, MaxNumber和maxNumber都是有区别的。  maxNumber可能是属性名; MaxNumber一般是类名; numberMax更倾向于方法。这里也有一个英文的搭配问题。

比如:FileRead, FileReader,  这个显然后者作为类名好些。

readFile,fileRead,   这个显然前者作为方法更合适。

下面的几个原则是编写 Java 程序必须遵守的
如果没有非常好的理由,永远不要违背他。

1.包
由小写字母和少量数字组成
Java 自己的包以 java. 和 javax 开头,比如:java.awt
别的组织开发的包以 组织的 Internet 域名部分开头,比如:com.sun, com.borland

一些例子:

com.aliasi.hmm;  com.aliasi.classify;  com.aliasi.cluster;

com:组织;  aliasi:具体的组织名或者个人;  classify,cluter:包名(主题)

org.apache.lucene;  org.apache.lucene.analysis.standard;

org.apache.nutch.ndfs; org.apache.nutch.fs; org.apache.nutch.db; org.apache.nutch.parse;

2.类,接口
由一个或几个单词组成,每个单词的第一个字母大写,比如:StringBuffer
类:一般用名词和名词词组命名;  IndexOptimizer.java;     WebDbReader.java
接口:与类相同,可以使用形容词词缀,比如 Runnable, Comparable

3.方法
除第一个字母小写外,和类,接口的命名规则一样。比如:getPersonInfo()
对于取属性值和设置属性值的方法:
不管是否是 Bean,都要遵循 JavaBean 命名规范:getXXX(), setXXX()
转换对象类型返回不同类型的方法:
命名成 toType,比如:toString(), toArray()
返回视图的方法:
命名成 asType() 形式,asList()
返回与调用此方法的对象(Wrapper Class)同值的原始类型的方法:
命名成 typeValue() 形式,比如 intValue(), floatValue()

parseCharacterEncoding(String);

4.域(属性)
普通域:
除第一个字母小写外,和类,接口的命名规则一样。比如:personInfo
常数域:
由一个或多个被下划线分开的单词组成,比如:VALUES, NEGATIVE_INTINITY
常数域是唯一允许使用下划线的情况。

5.局部变量
命名与域相同,可以使用简写,比如:i, j, temp, maxNumber

其实定义一个类和一个方法并不是太复杂,当时当有非常多的类、方法、变量的时候才复杂,每个要有区分、一致和相互联系。

时间: 2024-08-02 19:09:17

java命名规范:一些细节的相关文章

修炼成高薪Java程序猿——从优秀的Java命名规范开始

优秀的Java命名规范 1命名规范 1.1 package (*) 包名全部由小写的ASCII字母组成,用"."分隔. 在此项目中,所有的包均以"com.prosten.ticket"开头. 1.2 class (*) 类名应当是名词,每个内部单词的头一个字母大写.应当使你的类名简单和具有说明性.用完整的英语单词或约定俗成的简写命名类名. [示例]public class UserManager 1.3 interface(*) 接口名应当是名词,每个内部单词的头一

javaSE之java命名规范

java命名规范 1.Java中的名称规范: (1)包名全是小写:xxyyzz: (2)类名接口名:首字母大写:XxxYyy: (3)变量名和函数名:变量名不能是关键字:多单词组成时,第一个单词首字母小写,第二个单词开始每个单词首字母大写xxxYyyZzz.(驼峰表示法) (4)常量名:所有字母都大写.多单词时每个单词用下划线链接,XXX_YYY_ZZZ. 2.Java中书写程序的规范: (1)类包含方法,方法包含语句: (2)类名通常由英文单词组成(有意义的名称,可增加阅读性),首字母要大写:

再温习JAVA命名规范

Java编程规范整理 基本命名规范 包命名 包名按照域名的范围从大到小逐步列出,恰好和Internet上的域名命名规则相反. 由一组以"."连接的标识符构成,通常第一个标识符为符合网络域名的两个或者三个英文小写字母. PeopleTestPageXMLExample 类,接口命名 类的名字必须由大写字母开头而单词中的其他字母均为小写:如果类名称由多个单词组成,则每个单词的首字母均应为大写例如TestPage:如果类名称中包含单词缩写,则这个所写词的每个字母均应大写,如:XMLExamp

软帝学院教你java命名规范法则

java命名规范法则大全 在我们在刚开始学习java的时候,给包.类.方法等命名的时候总是取名不规范,大多都是随便取的,对于一个专业的程序员来说.命名规范化也是必不可少的.命名规范的话能够在编码过程中实现规范化,为以后的程序开发中养成良好的行为习惯.增加代码的易读性,可读性. 一.包(全部小写) 包名全部小写,但它不同的项目类型:1.个体项目(indi ): 如:indi.发起者名.项目名.模块名.…… 2.个人项目(pers): 如:pers.个人名.项目名.模块名.…… 3.私有项目(pri

JAVA命名规范

定义规范的目的是为了使项目的代码样式统一,使程序有良好的可读性. 包的命名  (全部小写,由域名定义) Java包的名字都是由小写单词组成.但是由于Java面向对象编程的特性,每一名Java程序员都 可以编写属于自己的Java包,为了保障每个Java包命名的唯一性,在最新的Java编程规范中,要求程序员在自己定义的包的名称之前加上唯一的前缀. 由于互联网上的域名称是不会重复的,所以程序员一般采用自己在互联网上的域名称作为自己程序包的唯一前缀. 例如:net.frontfree.javagroup

java命名规范和编程技巧

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

Java学习之路(一) —— Java命名规范

Package 的命名 Package 的名字应该都是由一个小写单词组成. Class 的命名 Class 的名字必须由大写字母开头而其他字母都小写的单词组成 Class 变量的命名 变量的名字必须用一个小写字母开头.后面的单词用大写字母开头. Static Final 变量的命名 Static Final 变量的名字应该都大写,并且指出完整含义. 参数的命名 参数的名字必须和变量的命名规范一致. 数组的命名 数组应该总是用下面的方式来命名: byte[] buffer; 而不是: byte b

Java命名规范小结

关于命名规范: 1,名副其实.即命名要有意义,能表达意思. 2,避免误导,避免给出有误导性质的元素,如xxxList. 3,做有意义的区分,避免同时使用Product,Product Info和ProductData.废话都是冗余的. 4,使用读得出来的名称. 5,使用可搜索的名称.主要针对常量. 6,避免使用编码.避免使用前缀 m_des和类型编码 phoneString. 7,类名是名称,方法名是动词或者动词短语(多用get, set, is).重载构造器用静态工厂方法. 8,别耍宝,用奇葩

java命名规范有感

一. 注()里的内容是自己的吐槽 二. 命名规约 不能以下划线或美元符开始和结尾.反例:_name,$name,name_,name$.(我就从来没这样用过) 不能使用拼音和英文组合方式命名.更不能以拼音命名(英语烂,有时犯过此类错误) 类名遵守驼峰规则(已遵守) 方法名,参数名,成员变量名,局部变量名统一lowerCamelCase格式(已遵守) 常量大写,单词间用下划线分隔,而且要表达清楚意思,长点都可以(已遵守) 抽象类命名使用Abstract或Base,异常名以Exception结尾,测