第一原则: 见名知意,类名最好用名字,方法名用动词。
在面向对象编程中,对于类、对象变量、方法等的命名是非常有技巧的,例如,大小写的区分,使用不同字母开头等。但究其本,在为一个资源命名时,应该本着描述性和惟一性两大特征,才能保证资源之间不冲突,并且便于理解记忆。
1.包的命名
Java包的名字都是由小写单词组成。一般采用域名的反写。
例如:com.foundersoftware.enotebook.demo。
2.类的命名
类的名字必须由大写字母开头,一个单词中的其他字母均为小写。如果类名称由多个单词组成,则建议将每个单词的首字母均用大写,例如TestPage。如果类名称中包含单词缩写,则建议将这个词的每个字母均用大写,如:XMLExample。由于类是设计用来代表对象的,所以建议在命名类时应尽量选择名词。
3.方法的命名
方法的名字的第1个单词应以小写字母开头,后面的单词首字母要大写,建议在方法命名时尽量选择动词。
例如:sendMessge()。
4.常量的命名
常量的名字应该都使用大写字母,并且指出该常量完整含义。如果一个常量名称由多个单词组成,则建议用下划线来分割这些单词。
例如:MAX_VALUE。
5.参数的命名
参数的命名规范和方法的命名规范相同,而且为了避免阅读程序时造成迷惑,请在尽量保证在参数名称为一个单词的情况下,参数的命名尽可能明确。
6.Javadoc注释
Java除了可以采用常见的注释方式之外,Java语言规范还定义了一种特殊的注释,也就是通常所说的Javadoc注释,它是用来记录代码中的API的。Javadoc注释是一种多行注释,以/**开头,而以*/结束,注释可以包含一些HTML标记符和专门的关键词。使用Javadoc注释的好处是编写的注释可以被自动转化为在线文档,省去了单独编写程序文档的麻烦。例如:
/**
*
*@author
*/
在每个程序的最开始部分,一般都用Javadoc注释进行程序的总体描述以及版权信息。在主程序中可以为每个类、接口、方法、变量添加Javadoc注释,每个注释的开头部分先用一句话概括该类、接口、方法、变量所完成的功能,这句话应单独占据一行以突出其概括作用,在这句话后面可以跟随更加详细的描述段落。
在描述性段落之后还可以跟随一些以Javadoc注释标签开头的特殊段落,例如上面例子中的@auther和@version,这些段落将在生成的文档中以特定方式显示。
7.工程名
工程名一般全用小写字母,每个单词之间加下划线或中划线,如‘ssh_training_itemmgr’
类、方法、接口之间最好空一行,多参考sun代码规范。
总结:
1.虽然添加注释不会使一个设计低劣的程序变成好的程序,但是如果按照编程规范编写程序,并且为程序添加良好的注释,却可以帮助编写出设计优美、运行高效且易于理解的程序,尤其在多人合作完成同一项目时,编程规范非常重要。俗话说"磨刀不误砍柴工",花费一点时间去适应一下Java编程规范是有好处的。
2.如果注释不规范,在自动管理项目时还会出现错误。例如在mvn site 时经常会出现javadoc错误提示。
分享到:
相关推荐
java命名规范: 英文版 Sun公司的标准
Java语言编码规范Sun.pdf Java编码规范第一参考和知道资料
sun公司的一些规范,敲代码必须知道的,为做一个成功的程序员。了解下没有害处
本文档讲述了Java语言的编码规范,较之陈世忠先生《c++编码规范》的浩繁详尽,此文当属短小精悍了。而其中所列之各项条款,从编码风格,到注意事项,不单只Java,对于其他语言,也都很有借鉴意义。因为简短,所以...
NULL 博文链接:https://liudojo1220.iteye.com/blog/1976473
sun java编码规范中文版 你不得不去了解的资料
Sun公司的Java语言编码规范 学习Java要养成好的编成风格阿~
java8源码包含sunjava8源码包含sunjava8源码包含sunjava8源码包含sunjava8源码包含sun
JNDI(Java Naming and Directory Interface)是SUN公司提供的一种标准的Java命名系统接口,JNDI提供统一的客户端API,通过不同的访问提供者接口JNDI SPI的实现,由管理者将JNDI API映射为特定的命名服务和目录系统,...
开发,从编程规范做起,该文档详细介绍了sun公司制定的java编程规范。
本规范是根据**公司多年的编程经验编写的《Java语言编程规范》和SUN公司《Java Coding Style Guide》结合而成的消息应用产品Java语言编程规范。在项目中,统一应用,将大大加快开发速度。
java sun.audio包,里面包含大部分音频操作的类,给需要的朋友
SUN Java培训教程
java1.7源码包含sun.经过测试可以使用。制作方法是jdk官方源码加sun的源码。
JAVA HTTP 发送 接收 com.sun.net.httpserver包 demo JAVA HTTP 发送 接收 com.sun.net.httpserver包 demo
java好书 thinking in java sun认证11本 java好书 thinking in java sun认证11本
Sun-Java语言编码规范.docx
本Java代码规范以SUN的标准Java代码规范为基础,为适应公司的实际需要,可能会做一些修改。本文档中没有说明的地方,请参看SUN Java标准代码规范。如果两边有冲突,以SUN Java标准为准。