java编程规范 (2).pdf
代码编写规范代码编写规范2012-04-25作者：DSH一、命名1、包（Package）包的名字应该能够说明包的用途，通常应是名词或名词短语。包的名字应该全部由小写字母构成；如果包的用途必须由两个或多个单词才能描述清楚，可以直接将这些单词连接作为包名；如果连接后的包名太长，可以使用单词的缩写（缩写必须不会引起歧义）或取每个单词的首字母。例如：2、类（Class）类的名字应该能够说明类的用途，通常应是名词或名词短语。类的名字由若干单词连接而成，每个单词的首字母应大写，其他字母小写。例如：A)实体类B)service 接口，例如：C)service 接口实现类，例如：D)actiona)实体类操作的 action，在实例类名后要加上 Manager，以示区别，例如：b)业务逻辑较为复杂的，单独设 action 和 service，例如：3、字段（field）字段的名字应该能够说明该字段的用途，通常取名词或名词短语，也可能是形容词。字段的名字由若干单词连接构成，第一个单词应全部小写，其余单词的首字母大写，例如：4、静态终态字段（static final field）静态终态字段的名字应该能够说明该字段的用途，通常取名词或名词短语，也可能是限定性的形容词或副词。静态终态字段的名字如果只有一个单词，则该单词应全部大写；静态终态字段如果由若干单词描述，则其名字应由这些单词以下划线（_）连接构成，每个单词均大写，例如：提倡：不提倡：5、数组（array）提倡：不提倡：6、局部变量（local variable）A)传参数的 Map，例如：B)临时实体变量，例如：C)for 循环中的临时实体变量，例如：7、参数（parameter）参数是指方法参数列表中的形参。参数的命名应遵循上述“字段”的命名规则。如果参数的意义与类中字段的意义相同，应尽可能使二者名字相同，例如：8、方法（method）所有的方法（构造函数除外）名都应能说明方法的用途，通常取动词或动词短语，也可能是名词或名词短语。方法名由若干单词连接而成，第一个单词应全部小写，其余单词的首字母大写。对于以名词或名词短语命名的方法，建议改成动词或动词短语形式。如果方法是用动词或动词短语来描述的，并且该方法是用来做判断或比较，返回一个 boolean 型的返回值，那么方法名以“isYyyXxxx”形式命名，且含义明确，如：“isUserNameExist”。A)service中的命名，例如：B)action 中命名，例如：9、特殊命名规范a)使用 get/set 对类属性进行访问，这是Java 社区的核心编码规范。b)使用is 前缀表示一个布尔变量和方法。isUsed,isEmpty,isVisible,isFinished有时也可以使用 has，can，should：boolean hasLicense();boolean canEvaluate();boolean shouldAbort=false;c)在查询方法中应使用find作为前缀vertex.findNearestVertex();matrix.findSmallestElement();node.findShortestPath(Node destinationNode);d)使用 initialize 做为对象初始化的方法前缀，也可以简写为initinitializeFiles();init();initFontSet();e)对于对象集合，变量名称应使用复数。Collection points;int values;f)对于抽象类，应该使用 Abstract 前缀。AbstractReportBuilder，AbstractBeanFactoryg)对于表示编号的变量，应加 No 后缀。tableNo,userNo,employeeNoh)常在一起使用的对称词汇，这些词汇一起使用，方法的表达意图自然可以互相推测和演绎。get/set,add/remove,create/destroy,start/stop,insert/delete,increment/decrement,begin/end,first/last,up/down,min/max,next/previous,old/new,open/close,show/hide,suspend/resumei)避免使用否定布尔变量bool isError;/避免:isNoErrorbool isFound;/避免:isNotFoundj)异常类应该使用 Exception 做为后缀。ccessException,RuntimeExceptionk)缺省接口实现应该使用 Default 前缀class DefaultTableCellRendererimplements TableCellRenderer l)对于单例类（Singleton），应该使用getInstance 方法得到单例。classclass UnitManager privateprivate finalfinal staticstatic UnitManager instance=new UnitManager();privateprivate UnitManager().publicpublic staticstatic UnitManager getInstance()returnreturn instance_;m)对于工厂类，进行创建对象的方法，应该使用 new 前缀classclass PointFactory publicpublic Point newPoint(.).9、spring&struts 相关A)Spring 配置文件中的 bean 的id，例如：不需要以模块名缩写加上 Service 名，例如：B)Struts中a)Package，例如：10、jsp（ftl）命名A)js 文件的 jspB)css 文件的 jspC)json以“JSON”结尾，例如:accountItemJSON.jspD)一般的 jsp第一个单词应全部小写，其余单词的首字母大写，例如：newAccountItem.jspeidtAccountItem.jspreadAccountItem.jspaccountItemList.jspE)通用的 jsp 或者 js 的有必要独立的的，命名以通用名开头，模块名结尾，例如：reportEditUser.js11、URL 的命名规范（待补充）URL 的命名要与 action 中方法的命名有区别12、js 的命名规范同上 3、5、6、7、9、1013、jsp，js 的文件夹的命名规范以模块为大的划分，功能点为小的划分依据，例如：二、代码风格1、jsp 代码风格A)include 的风格，例如：B)html 标签,注意格式对齐，例如：2、struts 配置文件的规范A)对齐方式，例如：，不提倡这样的对齐方式，例如：B)当返回值为 success 的时候，返回值标明，例如：不提倡不写，例如：C）method 也不提倡不写2、action 中的规范A)代码排版a)全局变量的排版b)getter and settergetter and setter 写在方法的下面，并用如上所示的标识分开getter and setter 的方法之间有一空行。B)action 方法的返回值尽量使用 struts 所提供的 SUCCESS，ERROR(慎用)，INPUT 等字段。特殊情况可以使用自定义的返回值，但得语义明确，例如：返回值的命名规范也遵守 field 的命名规范。3、代码块代码块是指用“”和“”包围的一段代码。代码块用于类的定义、方法的定义、循环的定义、条件分支的定义等情况。代码块中的“”应置于上一行代码的行末，并且与之前的代码之间用一个空格分隔；代码块中的内容则应在换行并缩进之后书写；代码块最后的“”应单独占一行，并与代码块开始的“”所处的行缩进位置相同。例如：不提倡写成：4、代码复用千万不要使用过多的“复制、粘贴”实现代码的复用。如果一段代码被复制、粘贴了超过3 次，就应该考虑将这段代码重新封装到一个方法中。如果出现第 4 个地方需要使用这段代码，并且需要对代码作稍许改动，则应该考虑将刚才封装的方法进行改造而不是重新定义一个方法。5、异常处理如果代码执行的过程中，捕获了一个异常，绝对不能简单地将这个异常“吃”掉或是打印一些类似于“1111111”的信息，而是应该谨慎对待因为异常包含了程序执行过程中的原始错误信息，良好的异常处理策略可以为后期的调试、维护等工作带来极大的便利。一般情况下不使用 try catch 来捕获异常，而是使用 throws 将异常抛出。6、spring 和 struts 的配置文件提倡以模块为单位使用单独的文件，命名方式以“struts-”开头，例如“struts-acc.xml”以“spring-”开头，例如“spring-acc.xml”三、注释1、文件标注每个Java源程序文件的开头都应加入该文件的javadoc注释，包含文件的作者、用途、等信息，例如：2、在每一个 java 方法头的上面加注释，注释的内容有方法的作用，作者，例如:3、在每一个 js 方法头上面加注释，注释的内容有方法的作用，作者，例如：4、在每一个 struts 配置文件中的 action 头上面加注释，注释内容有 action 的作用，返回，作者，例如：5、在业务逻辑复杂的方法体内加注释，且注释方式，例如：不提倡：6、如要修改他人的方法，需标明修改人，以及修改时间以及修改原因。7、使用 eclipse 的注释模板
