Java代码编写规范 Java代码编写程序的基本规范Word下载.docx
- 文档编号:22087878
- 上传时间:2023-02-02
- 格式:DOCX
- 页数:7
- 大小:18.30KB
Java代码编写规范 Java代码编写程序的基本规范Word下载.docx
《Java代码编写规范 Java代码编写程序的基本规范Word下载.docx》由会员分享,可在线阅读,更多相关《Java代码编写规范 Java代码编写程序的基本规范Word下载.docx(7页珍藏版)》请在冰豆网上搜索。
修订摘要
1
2
3
4
1.JAVA代码编写程序的基本规范
1.1Java命名规范
1.1.1使用完整描述符来准确地描述 参数或类。
例如,使用的名称可以是FirstName、GrandTotal或CorporateCustomer。
虽然像x1、y1或fn这样的名称较短容易输入,但是它们并不提供任何信息指出它们所代表的内容。
这样对代码的理解、维护和增强会造成一定困难。
(变量使用每个中文的头字母,变量第一个字母小写)。
1.1.2使用适用于领域内的术语。
如果您的用户将他们的客户称为顾客,则对这个类使用术语Customer来代替Client。
许多开发人员曾经犯了这样一个错误:
当业界或领域中已存在更贴切的术语时,他们还冥思苦想,准备为一些概念创建通用术语。
1.1.3巧妙节俭地使用缩写。
这表示您应该维护一份标准短格式(缩写)的列表,应该明智地选择它们,并在使用时保持一贯性。
例如,如果要使用字arithmetic的短格式,选择ar、ari或art中的一个,记录下所选的缩写(到底是哪个并不重要),并只使用这一个。
(陈涛负责)
1.1.4使用大小写混合增强名称的可读性。
通常应该使用小写字母,但是将类名和接口名称的第一个字母写成大写,将所有非起始单词的第一个字母也写成大写。
1.1.5将标准首字母缩写词的第一个字母大写。
名称会经常包含标准缩写,如SQL表示“StandardQueryLanguage”。
诸如表示属性的sqlDatabase或表示类的sQLDatabase等名称比sQLDatabase和SQLDatabase更便于阅读。
1.1.6避免长型名称(最大15个字符比较合适)。
虽然类名AllImplementedIterfacesAndSubclass可能是个比较好的类名(当然,在此示例中有些夸张),但是这个名称显然太长,应该把它重命名为较短的名称才好。
1.1.7避免名称过于相似或仅在大小写方面有区别。
不应该同时使用变量名myObject和myObjects,也不应该同时使用myOraDatabase和anORADatabase。
1.1.8方法的命名
方法名应该是动词,大小写可混用,但首字母应小写。
在每个方法名内,大写字母将词分隔并限制使用下划线。
参数的名字必须和变量的命名规范一致,问题参数名是否采用以下划线开始作为统一标识,如setCounter(int_size),以标识成员变量size和传入参数_size区别。
使用有意义的参数命名,如果可能的话,使用和要赋值的字段一样的名字:
setCounter(intsize){
this.size=size;
}
1.1.9数组的命名
数组应该总是用下面的方式来命名:
byte[]buffer;
而不是:
bytebuffer[]。
1.1.10Package的命名
Package的名字应该都是由一个小写单词组成,例如:
net.ebseries.modules。
1.1.11Class的命名
Class的名字必须由大写字母开头而其他字母都小写的单词组成,例如:
DataFile或InfoParser。
1.1.12Class变量的命名
变量的名字可大小写混用,但首字符应小写。
词由大写字母分隔,限制用下划线,限制使用美元符号($),因为这个字符对内部类有特殊的含义。
如:
inputFileSize。
类中的属性不能定义为public变量直接存取,而是定义成protect变量来防止继承类使用他们并编写get/set方法。
1.1.13Class属性(成员变量)使用
Class属性(成员变量)使用一定要加前缀this或super标识对应的成员变量,以增加程序的可读性。
1.1.14StaticFinal变量的命名
StaticFinal变量的名字应该都大写,并且指出完整含义,例如:
finalMAXUPLOADFILESIZE=1024。
1.2代码格式
1.2.1文档化
必须用javadoc来为类生成文档。
不仅因为它是标准,这也是被各种java编译器都认可的方法。
1.3缩进
缩进应该是每行4个空格.不要在源文件中保存Tab字符.在使用不同的源代码管理工具时Tab字符将因为用户设置的不同而扩展为不同的宽度。
1.3.1大括号{}
{}中的语句应该单独作为一行.例如,下面的第1行是错误的,第2行是正确的:
if(i>
0){i++};
//错误,{和}在同一行
0){
i++
};
//正确,{单独作为一行
1.3.2括号()
左括号和后一个字符之间不应该出现空格,同样,右括号和前一个字符之间也不应该出现空格.下面的例子说明括号和空格的错误及正确使用:
CallProc(AParameter);
//错误
CallProc(AParameter);
//正确
不要在语句中使用无意义的括号.括号只应该为达到某种目的而出现在源代码中。
下面的例子说明错误和正确的用法:
if((I)=42){//错误-括号毫无意义
if(I==42)or(J==42)then//正确-的确需要括号
1.3.3注释
//注释一行
/*......*/注释若干行
文档注释:
/**......*/注释若干行,并写入javadoc文档
在每个源文件的头部要有必要的注释信息,包括:
文件名;
版本号;
作者;
生成日期;
模块功能描述(如功能、主要算法、内部各部分之间的关系、该文件与其它文件关系等。
在每个函数或过程的前面要有必要的注释信息,包括:
函数或过程名称;
功能描述;
输入、输出及返回值说明;
调用关系及被调用关系说明等。
1.4方法
1、方法的规模尽量限制在200行以内。
2、一个方法最好仅完成一件功能。
3、为简单功能编写方法。
4、方法的功能应该是可以预测的,也就是只要输入数据相同就应产生同样的输出。
5、尽量不要编写依赖于其他方法内部实现的方法。
6、避免设计多余参数方法,不使用的参数从接口中去掉。
7、用注释详细说明每个参数的作用、取值范围及参数间的关系。
8、检查方法所有参数输入的有效性。
9、检查方法所有非参数输入的有效性,如数据文件、公共变量等。
10、方法名应准确描述方法的功能。
11、避免使用无意义或含义不清的动词为方法命名
12、方法的返回值要清楚、明了,让使用者不容易忽视错误情况。
13、明确方法功能,精确(而不是近似)地实现方法设计。
14、减少方法本身或方法间的递归调用。
(递归优点:
是程序易读,易编程;
缺点:
效率不高,增加了系统的开销,每递归一次,栈内存就多占用一截。
)
1.5jsp规范(使用英文单词,最大长度20位)
1、jsp目录命名规范
参照Package命名规则,用小写单个单词作为目录名。
2、jsp文件名规范
参照class命名规则,采用首子母大写,多单词间采用大写字母分割。
3、jsp传递参数命名规则
参照class变量命名规划。
4、文件命名其它常见规范
5、jsp主页面(游览功能)XxxxIndex.jsp(一般记录的删除在此页面做连接)
6、jsp添加功能页面XxxxAdd.jsp
7、jsp修改功能页面XxxxModify.jsp
8、jsp删除功能页面XxxxDel.jsp
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- Java代码编写规范 Java代码编写程序的基本规范 Java 代码 编写 规范 程序 基本