还剩4页未读,继续阅读
文本内容:
J__a编码规范目录TOC\o1-3\h\z\u1前言42命名规范
42.1Package
42.2File
42.3Class
42.4Inte_____
42.5常量
42.6变量
52.7Method53文件规范
53.1注释
53.2Package/Imports
63.3Class
63.
3.1构造函数64缩进排版规范65申明规范76语句规范77编程规范78JSP页面规范81前言本文档主要是为__内部使用J__a语言进行程序__的人员提供一个源代码书写标准,以及程序和文件的命名标准,使得能在编程时遵循一致的格式2命名规范
2.1PackagePackage的名字总是全部小写的字母采用基于项目以及服务的命名习惯,com.cu.___.Servi__Name.XXX,如路由服务的数据库层包名com.cu.___.route.dao
2.2FileJ__a编译器强制规定文件名必须和文件中定义的publicclass的名称一致
2.3ClassClass的名字类名是一个名词,采用大小写混合的方式,每个单词的首字母大写,例如BaseUser
2.4Inte_____需要区分相似的class的名,Inte_____以I开头,同时后面的第二个字母大写,例如IbaseUser.j__a
2.5常量常量的声明应该全部大写,每个单词之间用_连接例如finalString____CROSSTEK_CN=___.crosstek.cn;
2.6变量变量名第一个字母小写,任何中间单词的首字母大写变量名应简短且可以顾名思义,易于记忆例如crosstekName、crosstekAddress避免单个字符的变量名,除非是一次性的临时变量
2.7Method方法名是一个动词或动词词组,采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写例如setCrosstekNameStringneekeName3文件规范
3.1注释在所有的J__a(*.j__a)文件都必须遵守如下的样式规则示例/***pTitle:类名/p*pDescription:类的功能描述/p*pCopyright:AllRightsReserved/p*pCompany:北京飞天经纬/p*@author__*@createddate创建时间*/
3.2Package/Importspackage行要在import行之前,import中标准的包名要在本地的包名之前,而且按照字母顺序排列如果import行中包含了同一个包中的不同子目录,则应该用*号来处理Packagehotj__a.net.stats;Importj__a.io.*;Importj__a.util.Observable;Importhotj__a.util.Application;这里j__a.io.*使用来代替InputStreamandOutputStream的
3.3Class
3.
3.1构造函数接下来是构造函数,它应该用递增的方式写(比如参数多的写在后面)访问类型(public,private等.)和任何static,final或synchronized应该在一行中,并且方法和参数另写一行,这样可以使方法和参数更易读如publicCounterSet(intsize){this.size=size;}4缩进排版规范
(1)避免一行的长度超过60个字符
(2)使用Eclipse的源代码的格式化功能完成代码的缩进排版(jsp页面不要使用格式化工具排版)5申明规范
(1)一行声明一个变量
(2)不要将不同类型变量的声明放在同一行
(3)只在代码块的开始处声明变量
(4)所有的变量必须在声明时初始化
(5)避免声明的局部变量覆盖上一级声明的变量
(6)方法与方法之间以空行分隔6语句规范
(1)每行至少包含一条简单语句
(2)在return语句中,返回值不使用小括号括起来
(3)if语句总是用{和}括起来
(4)在for语句的初始化或更新子句中,避免因使用三个以上变量,而导致复杂度提高
(5)当switch的一个case顺着往下执行时(因为没有break语句),通常应在break语句的位置添加注释7编程规范
(1)提供对实例以及类变量的public或private访问控制,尽可能不使用默认值或protected访问控制
(2)避免用一个对象访问一个类的静态变量或方法应该用类名代替
(3)避免在一个语句中给多个变量赋相同的值
(4)用switch语句实现多路分支
(5)如果使用JDBC,则考虑使用j__a.sql.PreparedStatement,而不是j__a.sql.Statement
(6)用于设置对象状态的方法前缀必须是set;用于检索一个布尔类型对象状态的方法前缀必须是is,而用于检索其他方法前缀必须是get
(7)程序中应尽可能少使用数字(或字符),尽可能定义静态变量来说明该数字(或字符)的含义程序中需要赋值或比较时,使用前面定义的静态变量在循环控制中例外发布出去的文件不能有System.out.println类似的打印语句8JSP页面规范页面名称都用小写字母,每个单词之间用_连接页面不能有打印语句每个页面添加如下的代码去除页面缓存metahttp-equiv=Prag__content=no-cache/metahttp-equiv=Cache-Controlcontent=no-cache/metahttp-equiv=Expirescontent=0/PAGE第6页共6页。