欢迎来到天天文库
浏览记录
ID:19874295
大小:77.50 KB
页数:12页
时间:2018-10-07
《java编程规范28398new》由会员上传分享,免费在线阅读,更多相关内容在教育资源-天天文库。
1、Java编码规范Java编码规范制定本编程格式的目的是为了使软件可读性好、兼容性好、易维护等等。注:加(*)者为重要保证要求。一、命名规范1.1Package的命名(*)Package的名字应由一个小写单词组成。为了保证包的唯一性,一般以公司国际域名开头。例如:com.te。1.2Class的命名(*)Class的名字必须由大写字母开头,并且其它单词的首写字母也要大写。例如:DbAccess。1.3Class成员属性及变量的命名(*)变量/成员属性的名字用一个小写字母开头,后面的单词以大写字母开头。例如:privateStringlastNa
2、me;1.4常量的命名(*)Java里的常量,是用staticfinal修饰的,应该用全大写加下划线命名,并且常量名应尽量指出完整含义。如:publicstaticfinalStringORACLE_DB_DRIVER="oracle.jdbc.driver.OracleDriver";1.5数组的命名数组应该总是用下面的形式来命名:byte[]buffs;而不是:bytebuffs[];1.6方法的参数和变量的命名规范一致,且应使用有意义的参数命名,如果可能的话,使用和要赋值的属性一样的名字,如:setCounter(intsize){Ja
3、va编码规范this.size=size;}1.7方法命名(*)用一个小写字母开头,后面的单词以大写字母开头。应意义明确,对于属性的存取方法,应使用getXXX()和setXXX()名称,以isXXX(),hasXXX()来命名返回值为boolean类型的方法。1.8一般命名注意事项a.用有意义的名字命名变量首先,用完整的英语单词或约定俗成的简写命名变量,鼓励多用约定俗成的简写命名变量。例如:publicStringzipCodepublicinterrNob.用复数命名Collection类变量Collection,包括数组,Vector等
4、。命名时使用复数:例如:publicCollectioncustomers二、Java源文件样式Java(*.java)源文件应遵守如下的样式规则2.1Class代码布局:packageJavadoc注释或者其它文件头注释类声明Fields声明空行构造函数空行克隆方法空行其它方法(不包括main)空行Java编码规范内部(Inner)类空行main()方法2.2版权信息版权信息必须在java文件的开头,例如:/***
Title:编码过滤器
Description:该类实现把request请求编码为web.xml文件中所配置
5、的字符集
Copyright:Copyright(c)2003
Company:广州德易计算机科技有限公司
6、tpakage.*来处理,推荐把要用的类一一import出来。这样程序用到哪些类就可以非常清楚的看出来,有利于代码的维护,增强了代码的可读性。例如:importjava.util.Observable;importjava.util.Date;importjavax.sql.Connection;//ApacheXercesJava编码规范importorg.apache.xml.*;importorg.apache.xerces.dom.*;//Applicationclassesimportcom.te.db.DbAccess2.4Cla
7、ssFields类的成员变量:/***Packetcounters*/protectedint[]packets;public的成员变量必须以生成文档(JavaDoc)的方式进行注释(/**…*/)。protected、private和package定义的成员变量如果名字含义明确的话,可以没有注释。Field定义可遵从以下顺序:a.public常量b.public变量c.protected常量d.protected变量e.package常量f.package变量g.private常量h.private变量2.5构造方法(*)重载的构造方法应该
8、用递增的方式写(参数多的写在后面)。publicCounterSet(){this(10);}publicCounterSet(intsize){this.size
此文档下载收益归作者所有