最新Java编码规范教学讲义PPT课件.ppt

《最新Java编码规范教学讲义PPT课件.ppt》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、Java编码规范编码规范内容目的源程序命名规范空白的使用注释类接口语句源程序源文件的组织包的声明必须是非注释的第一行，用一个空格分隔package关键字与包的名字，如：packagecom.neusoft.softdev.firewall;引用声明从第一列开始用一个空格分隔import关键字和引用类型名。应保证引入类都被使用，减少引入*的使用。※importjava.sql.SQLException;//GOODImportjava.sql.*;//BAD类或接口声明每个源程序必须有一个class或interface声明命名规范包的命名类和接口的命名变量命名常量命名方法命名命

2、名规范包的命名全部由小写字母组成。如：packagetelmecall.business.console;packagetelmecall.business.exception;packagetelmecall.presentation.util;其中telmecall指项目名称business指业务逻辑console指具体模块命名规范类和接口的命名一般由大写字母开头其它字母小写的单词组成专有的缩写词除外，如：AWTExceptionclass名字建议用名词或名词短语interface名字取决于其主要功能和用途是使Object具有特定的功能，建议使用可以描述此功能的形容词（加

3、上-able或者-ible后缀）如：Searchable,Sortable,NetworkAccessible等否则，建议使用名词或者名词短语命名规范变量命名采用大小写混合的形式以小写字母开头，名字中其他单词（或只取首字母的缩写单词）以大写字母开头，其它都为小写字母不使用下划线分隔应为名词或名词短语例：booleanresizable;charrecordDelimiter命名规范常量命名建议都为大写字母用下划线分隔单词如：MIN_VALUE,MAX_BUFFER_SIZE,PTION_FIEL_NAME命名规范方法命名采用大小写混合的形式以小写字母开头，其他单词（或只取首字

4、母的缩写单词）以大写字母开头，所有其它字母小写。不使用下划线分隔单词方法命名应能描绘出方法的作用和功能建议使用祈使动词或动词短语获取或设置类属性的方法建议显示的命名为getProperty()或setProperty()，其中property是类的属性的名字用于判断类的布尔属性的方法建议显示的命名为isProperty()，property是指类的属性的名字※空白的使用空行空格缩进行的延续（折行）空白的使用空行有益于将代码按照逻辑分段，以提高代码的可读性。※下列情况用一个空行：在版权声明、包声明块、引用声明块之后在类的声明之间在方法的声明之间在类中声明最后一个属性之后，声明第

5、一个方法之前空白的使用空格下列情况建议使用单个空格：在一个关键字和它所修饰的块之间。如：catch,for,if,switch,synchronized,while。注意super,this后不要跟空格任何关键字和它所用的参数之间。如：returntrue;一个列表中逗号之后。如：foo(long_exp1,long_exp2,long_exp3);//GOODfoo(long_exp1,long_exp2,long_exp3);//BAD下列情况不建议使用空格：左括号和后一个字符之间右括号和前一个字符之间if(i==42)//GOODif(i==42)//BAD空白的使用缩

6、进要求是四个空格TAB在不同的源代码管理工具中因为用户设置的不同宽度不相同，因此不要使用TAB建议修改各管理工具的设置将TAB字符扩展为4个空格行的延续（折行）行应为120列，超出此限制应截成比较短的行在逗号之后折行或一个操作符之前折行△※尽可能采用高层次的折行※折行后对齐上一行语句同一层的起始位置※如果上面规则不适用，则缩进4个字符注释应能够帮助读者理解代码的功能和作用、程序的流程注释要言简意赅须注意注释的正确性，错误的注释还不如不做注释临时的注释用“temporarynote”进行标注，以利于将来程序发布时将其删去，如：//temporarynote:Changethis

7、tocallsort()whenthebugs...源码中加入适当的注释，可自动生成与源码同步的文档注释版权信息注释类注释成员注释方法注释内部类的注释其它的注释注释版权信息注释必须在java文件的开头，建议如下格式：/**$Header$*$Revision$*$Date$**Copyright(c)2007东软IT实训中心*/注释类注释通常放在类定义的前面（类实体以外）通常详细介绍该类的功能、作者、版本，“@deprecated”标志的使用，以及产生该类的时间和引用其他类等信息/***

Descr