Java程序开发规范
Java 编程规范
注：本规范适用于北京工业大学教育部数字社区工程研究中心进行java开发，还待进一步完善。
Java程序开发规范
第1章绪论
1.1 目的:
本规范目的是为了使本组织能以标准、规范、统一的编程风格进行Java代码的开发工作。提高程序的可读性、可修改性和可维护性，方便团队的交流。
本规范参考了:
<>
<<高质量C++编程>>
1.2 范围:
本规范适用于教育部数字社区工程研究中心使用Java开发团队所有成员，进行产品开发、维护以及升级等编程操作。
1.3 概要说明:
在这里引用文献1来说明代码规范的重要性:
一个软件的生命周期中，有80%都在进行维护；
很难有软件在整个生命周期中，都是由原来的作者进行维护的；
编码规范提高了软件的可读性，并且帮助软件工程师更加快速彻底地理解新的代码；
要想把你的源代码作为产品来发布，就需要保证它像你创作的其他作品那样被很好地封装，并且清理干净了。
针对我们学校环境来说，师兄师姐毕业，师弟师妹入学属于软件工程师的不
断更新，如果我们没有统一的完成的编程规范，每个人按照自己的编程风格和编程方法进行程序开发，在毕业之后很少有人能读懂他的程序，对于后期的维护来说是一件非常头疼的问题，所以我们非常有必要总结出一套适合我们自己的Java 开发规范。
1.4 重要说明:
本规范为内部共享资源，版权属于教育部数字工程研究中心，如果现在或者以后有好的建议可以直接在该文件中进行添加和修改。
第2章代码整体组织和风格
这里所说的代码的整体组织和风格是针对一个文件而言，一个文件应该是由被空行分隔开的代码块所组成，并且每个块被特定的注释标识出来。每个文件不应该超过2000行(包括注释说明)。
2.1 Java源文件
Java源文件必须包含一下几个部分(按照从上到下的顺序说明)：版权说明、包和引用语句、类/接口描述以及版本信息、类方法以及变量声明和实现。
版权信息，所有的源文件都应该由列出了类名，日期和版权信息的C-style 的注释开始，采用如下格式作为版权信息:
/**
*@{#}S.java Created on2009-4-6
*
*CopyRight(c)2009BJUT,BeiJing.
*All right reserved.
*/
包和引用语句, 大多数Java源文件的第一个非注释代码行都是包定义语句,当让可以不写包定义语句，但是在这里强烈建议写上包定义语句(如果你采用eclipse等开发环境写不写就由不得你了，除非你在它自动生成之后将其删掉)，在之后就是引用语句，如果引用的话当然没有引用语句。做如下规
定：
1)包信息和引用语句之间要与一个空行
2)引用语句之间不在同一个包中的引用也要有一个空行
例如：
package edu.bjut.bjwater.checkrules.action;
import java.text.NumberFormat;
import java.text.SimpleDateFormat;
import java.util.*;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
import edu.bjut.bjwater.pub.*;
类/接口描述以及版本信息
/**
*@Package:src.test
*@Description:TODO(用一句话描述该文件做什么)
*@author:yan
*@date:2009-4-6
*@version:V1.0
*
*@version@date@author@modify
*------------------------------------------------
*修改之后版本修改日期修改者修改内容
*/
变量声明，按照文献1中所说，在声明变量时，首先声明static变量然后再声明类成员变量，声明顺序为，首先是public的类变量，然后是protected 的,接下来是包级的（没有访问修饰符），最后是private的。例：
/**something......*/
public static String str = “test”;
…………………
/**
*Set the character set for the file.
*/
private static Charset charset = Charset.forName("ISO-8859-15");
/**something......*/
public String str = “test”;
/**
*The character buffer reference.
*/
private CharBuffer indexFile;
变量声明同时也要添加相应注释，注释这个变量的功能，如果是一个较复杂的数据结构形式，将其存贮的格式也表示出来，方便理解程序同时也方便其他人的程序调用。
构造函数和方法:构造函数也是方法但是它没有返回值，本规范规定，想写构造函数在写其他的方法。方法也要加上注释，说明这个方法实现的功能等信息，例如
/**
*@Title:main
*@Description:TODO方法功能描述
*@param args
*@author:yan2009-4-6
*@version:
*
*@version@date@author@modify
*------------------------------------------------
*修改之后版本修改日期修改者修改内容
*/
方法的参数以及返回类型一定要详细填写，参数包括参数要求的类型，以及参数的说明；返回值包括返回的类型以及返回之后的数据结构等信息。
2.2 缩进
缩进使得程序看起来清晰和结构化，本规范规定采用4个空格作为缩进单位。eclipse默认的TAB缩进为4个空格，不同的IDE工具可能不太一样，需要进行设置TAB代表的空格。但是如果程序层次缩进过多的话使得程序易读性差，在遇到这种情况时应将部分子功能提取出来作为单独的方法。
2.3 函数体长度
前面已经提到整个文件不应该超过2000行，而作为函数体也有相应的要求，为了方便程序阅读和理解，函数体应该尽量控制在150行左右(只是看到有人这样写，具体多少合适我也不是很清楚)。避免出现大类和大方法，对于程序的维护是相当困难的。所以我们提倡小方法以及方法的重用性操作。
2.4 行宽
本规范规定每一行的最长宽度为80字符，因为超过了这个宽度之后有些工具不能很好的处理，就算是能够处理，我们也不要超过这个宽度，这也是程序可读性的一个要求。
2.5 换行
换行在编程的时候是避免不了的，所以对于换行文献1中提出了一些基本的要求。
在一个“，”后面断行
在一个操作符前面换行，操作符放在新行之首(确保突出操作符)
在较高级别处换行，不要在较低级别处换行
if表达式尽量使用8个空格换行操作，因为4个空格换行操作使得函数体不容易辨认。
拆分出的新行要适当进行缩进，使得排版整齐，可读性强。
例：
2.6 空行
适当空行的使用可以提高代码的可读性。规定如下：
在下列情况下使用一个空行
两个方法之间
块注释或者单行注释之前
一个方法的两个逻辑段之间，逻辑上密切的地方不加空行，其他地方应该加上空行分隔
2.7 空格
在下列情况下使用空格：
1)关键字之后要留空格。象const、static、final等关键字之后至少要留
一个空格，否则无法辨析关键字。象if、for、while等关键字之后应留
一个空格再跟左括号‘（’，以突出关键字。
2)函数名之后不要留空格，紧跟左括号‘（’，以与关键字区别。
3)“，”或者“；”后要留空格，如for (initialization; condition; update)、
Function(int x, int y, int z)
4)“(”向后跟紧，除了“（”前为关键字情况留空格外，而“）”、“；”向前跟紧，也
就是在他们之前没有空格出现；
5)所有的二元操作符号：赋值操作符、比较操作符、算术操作符、逻辑操
作符、位域操作符，如“=”、“+=”“>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元操作符的前后应当加空格。
6)所有一元操作符前后不加空格，“!”、“++”、“--”前后都不加空格
7)强制转换后应该紧跟一个空格，如myMethod((byte) aNum, (Object) x);
第3章命名规范
3.1 基本规则
规范化的命名可以使程序易于阅读和理解，不仅仅方便自己日后看程序方便同时也方便他人进行代码的维护工作。
a)命名是采用完成的英文描述，禁止使用汉语拼音和汉语进行命名。
b)尽量少用缩写形式命名
c)命名中尽量少出现或者不出现数字，当然用2代表to,或者4代表for
是可以的。
d)避免使用相似或者仅仅在大小写上区分的名字
注意：在程序开发过程中避免出现莫名的数字，既然是一个常量，那就给定义为常量来操作，不要出现不知道是什么意思的常量，使得程序变得很神秘。
第4章表达式和基本语句
第5章注释
第6章附录—版本信息
一、GNU 风格的版本号命名格式:
主版本号. 子版本号[. 修正版本号[. 编译版本号]]
英文对照:
Major_Version_Number.Minor_Version_Number[.Revision_Number[.Build_Number ]]
示例: 1.2.1, 2.0, 5.0.0 build-13124
二、Windows 风格的版本号命名格式:
主版本号. 子版本号[ 修正版本号[. 编译版本号]]
英文对照:
Major_Version_Number.Minor_Version_Number[Revision_Number[.Build_Number]] 示例: 1.21, 2.0
三、.Net Framework 风格的版本号命名格式:
主版本号.子版本号[.编译版本号[.修正版本号]]
英文对照:
Major_Version_Number.Minor_Version_Number[.Build_Number[.Revision_Number ]]
版本号由二至四个部分组成：主版本号、次版本号、内部版本号和修订号。主版本号和次版本号是必选的；内部版本号和修订号是可选的，但是如果定义了修订号部分，则内部版本号就是必选的。所有定义的部分都必须是大于或等于0 的整数。
应根据下面的约定使用这些部分：
Major ：具有相同名称但不同主版本号的程序集不可互换。例如，这适用于对产品的大量重写，这些重写使得无法实现向后兼容性。
Minor ：如果两个程序集的名称和主版本号相同，而次版本号不同，这指示显著增强，但照顾到了向后兼容性。例如，这适用于产品的修正版或完全向后兼容的新版本。
Build ：内部版本号的不同表示对相同源所作的重新编译。这适合于更改处理器、平台或编译器的情况。
Revision ：名称、主版本号和次版本号都相同但修订号不同的程序集应是完全可互换的。这适用于修复以前发布的程序集中的安全漏洞。
程序集的只有内部版本号或修订号不同的后续版本被认为是先前版本的修补程序(Hotfix) 更新。
版本号管理策略
一、GNU 风格的版本号管理策略：
1．项目初版本时, 版本号可以为0.1 或0.1.0, 也可以为1.0 或1.0.0, 如果你为人很低调, 我想你会选择那个主版本号为0 的方式;
2．当项目在进行了局部修改或bug 修正时, 主版本号和子版本号都不变, 修正版本号加1;
3. 当项目在原有的基础上增加了部分功能时, 主版本号不变, 子版本号加1, 修正版本号复位为0, 因而可以被忽略掉;
4．当项目在进行了重大修改或局部修正累积较多, 而导致项目整体发生全局变化时, 主版本号加1;
5．另外, 编译版本号一般是编译器在编译过程中自动生成的, 我们只定义其格式, 并不进行人为控制.
二、Window 下的版本号管理策略：
1．目初版时, 版本号为1.0 或1.00;
2. 当项目在进行了局部修改或bug 修正时，主版本号和子版本号都不变, 修正版本号加1;
3. 当项目在原有的基础上增加了部分功能时, 主版本号不变, 子版本号加1, 修正版本号复位为0, 因而可以被忽略掉;
4. 当项目在进行了重大修改或局部修正累积较多, 而导致项目整体发生全局变化时, 主版本号加1;
5. 另外, 编译版本号一般是编译器在编译过程中自动生成的, 我们只定义其
格式, 并不进行人为控制.
另外, 还可以在版本号后面加入Alpha, Beta, Gamma, Current, RC (Release
Candidate), Release, Stable 等后缀, 在这后缀后面还可以加入1 位数字的版本号.
对于用户来说, 如果某个软件的主版本号进行了升级, 用户还想继续那个软件, 则发行软件的公司一般要对用户收取升级费用; 而如果子版本号或修正版本号发生了升级, 一般来说是免费的.
附：alphal 内部测试版
beta 外部测试版
demo 演示版
Enhance 增强版或者加强版属于正式版
Free 自由版
Full version 完全版属于正式版
shareware 共享版
Release 发行版有时间限制
Upgrade 升级版
Retail 零售版
Cardware 属共享软件的一种，只要给作者回复一封电邮或明信片即可。（有的作者并由此提供注册码等），目前这种形式已不多见。
Plus 属增强版，不过这种大部分是在程序界面及多媒体功能上增强。
Preview 预览版
Corporation & Enterprise 企业版
Standard 标准版
Mini 迷你版也叫精简版只有最基本的功能
Premium —贵价版
Professional —专业版
Express —特别版
Deluxe —豪华版
Regged —已注册版
CN —简体中文版
CHT —繁体中文版
EN —英文版
Multilanguage —多语言版
注释：
α版
此版本表示该软件仅仅是一个初步完成品，通常只在软件开发者内部交流，也有很少一部分发布给专业测试人员。一般而言，该版本软件的bug 较多，普通用户最好不要安装。
β（beta）版
该版本相对于α版已有了很大的改进，消除了严重的错误，但还是存在着一些缺陷，需要经过大规模的发布测试来进一步消除。这一版本通常由软件公司免费发布，用户可从相关的站点下载。通过一些专业爱好者的测试，将结果反馈给开发者，开发者们再进行有针对性的修改。该版本也不适合一般用户安装。γ版
该版本已经相当成熟了，与即将发行的正式版相差无几，如果用户实在等不及了，尽可以装上一试。
trial（试用版）
试用版软件在最近的几年里颇为流行，主要是得益于互联网的迅速发展。该版本软件通常都有时间限制，过期之后用户如果希望继续使用，一般得交纳一定的费用进行注册或购买。有些试用版软件还在功能上做了一定的限制。unregistered（未注册版）
未注册版与试用版极其类似，只是未注册版通常没有时间限制，在功能上相对于正式版做了一定的限制，例如绝大多数网络电话软件的注册版和未注册版，两者之间在通话质量上有很大差距。还有些虽然在使用上与正式版毫无二致，但是动不动就会弹出一个恼人的消息框来提醒你注册，如看图软件acdsee 、智能陈桥汉字输入软件等。
demo版
也称为演示版，在非正式版软件中，该版本的知名度最大。demo 版仅仅集成了正式版中的几个功能，颇有点像unregistered 。不同的是，demo 版一般不能通过升级或注册的方法变为正式版。
以上是软件正式版本推出之前的几个版本，α、β、γ可以称为测试版，大凡成熟软件总会有多个测试版，如windows 98 的β版，前前后后将近有10 个。这么多的测试版一方面为了最终产品尽可能地满足用户的需要，另一方面也尽量减少了软件中的bug 。而trial 、unregistered 、demo 有时统称为演示版，这一类版本的广告色彩较浓，颇有点先尝后买的味道，对于普通用户而言自然是可以免费尝鲜了。
正式版不同类型的软件的正式版本通常也有区别。
release
该版本意味“最终释放版”，在出了一系列的测试版之后，终归会有一个正式版本，对于用户而言，购买该版本的软件绝对不会错。该版本有时也称为标准版。一般情况下，release 不会以单词形式出现在软件封面上，取而代之的是符号(r) ，如windows nt(r) 4.0 、ms-dos(r) 6.22 等。
registered
很显然，该版本是与unregistered 相对的注册版。注册版、release 和下面所讲的standard 版一样，都是软件的正式版本，只是注册版软件的前身有很大一部分是从网上下载的。
standard
这是最常见的标准版，不论是什么软件，标准版一定存在。标准版中包含了该软件的基本组件及一些常用功能，可以满足一般用户的需求。其价格相对高一级版本而言还是“平易近人”的。
deluxe
顾名思义即为“豪华版”。豪华版通常是相对于标准版而言的，主要区别是多了几项功能，价格当然会高出一大块，不推荐一般用户购买。此版本通常是为那些追求“完美”的专业用户所准备的。
reference
该版本型号常见于百科全书中，比较有名的是微软的encarta 系列。reference 是最高级别，其包含的主题、图像、影片剪辑等相对于standard 和deluxe 版均有大幅增加，容量由一张光盘猛增至三张光盘，并且加入了很强的交互功能，当然价格也不菲。可以这么说，这一版本的百科全书才能算是真正的
百科全书，也是发烧友们收藏的首选。
professional（专业版）
专业版是针对某些特定的开发工具软件而言的。专业版中有许多内容是标准版中所没有的，这些内容对于一个专业的软件开发人员来说是极为重要的。如微软的visual foxpro 标准版并不具备编译成可执行文件的功能，这对于一个完整的开发项目而言显然是无法忍受的，若客户机上没有foxpro 将不能使用。如果用专业版就没有这个问题了。
enterprise（企业版）
企业版是开发类软件中的极品（相当于百科全书中的reference 版）。拥有一套这种版本的软件可以毫无障碍地开发任何级别的应用软件。如著名的visual c++ 的企业版相对于专业版来说增加了几个附加的特性，如sql 调试、扩展的存储过程向导、支持as/400 对ole db 的访问等。而这一版本的价格也是普通用户无法接受的。如微软的visual studios 6.0 enterprise 中文版的价格为23000 元。
其他版本除了以上介绍的一些版本外，还有一些专有版本名称。
update（升级版）
升级版的软件是不能独立使用的，该版本的软件在安装过程中会搜索原有的正式版，如果不存在，则拒绝执行下一步。如microsoft office 2000 升级版、windows 9x 升级版等等。
OEM版
OEM版通常是捆绑在硬件中而不单独销售的版本。将自己的产品交给别的公司去卖，保留自己的著作权，双方互惠互利，一举两得。
单机（网络）版
网络版在功能、结构上远比单机版复杂，如果留心一下软件的报价，你就会发现某些软件单机版和网络版的价格相差非常大，有些网络版甚至多一个客户端口就要加不少钱。
普及版
该版本有时也会被称为共享版，其特点是价格便宜（有些甚至完全免费）、功能单一、针对性强（当然也有占领市场、打击盗版等因素）。与试用版不同的
是，该版本的软件一般不会有时间上的限制。当然，如果用户想升级，最好还是去购买正式版。
Java开发规范
Java开发规范
目录 第1章序言 (4) 第2章java一般性研发规范 (5) 2.1 代码格式 (5) 2.1.1包、类、方法的命名规范: (5) 2.1.2方法的命名应注意避免与java中具有特殊意义的名称例如equals， hashCode，clone，finalizer等冲突 (7) 2.1.3Java bean中取得boolean类型的属性值必须使用is****形式命名 (9) 2.1.4if,else,while,for等必须使用{} (9) 2.1.5类必须包含在包里，禁止出现无包的类 (10) 2.1.6类和方法必须拥有注释，注释量占总体代码25%以上，类头部，以及方法 头部的注释应符合javadoc标准。 (11) 2.2 基本语法 (12) 2.2.1不能随意捕捉异常，原则上谁捕捉谁处理 (12) 2.2.2if，while，try，finally，switch ，synchronized ，static instantiation 里面应有相应的逻辑处理，不能为空。 (13) 2.2.3在处理循环中，不能在程序中人为的改变步长。 (14) 2.2.4将简单类型int，short，float，double等转化成字符串时，需使用其对 应类的toString方法。 (14) 2.2.5javaBean中hashCode，以及equals方法必须同时override。 (15) 2.2.6懒式方式创建对象：不能采用双检查惯用法 (18) 2.2.7不能在finally中返回值。 (19) 2.2.8Boolean实例化时，应用使用Boolean.valueOf，Boolean.TRUE， Boolean.FALSE。 (19) 2.2.9Integer,Byte,Short,Long等实例化时，应用使用valueOf (20) 2.2.10对于多个if语句嵌套的情况下能够整合尽量整合。 (20) 2.2.11override function，不能只有super.function语句，否则视为无效代码 21 2.2.12Collection.toArray的注意事项。 (21) 2.2.13对于BigDecimal方法，应避免使用float值，double值进行创建，应使 用字符串形式创建。 (22) 2.2.14String,BigDecimal,BigInteger等值类型调用replace，add等方法的注 意事项。 (23) 2.2.15需要注意的引起NullException的语句。 (23) 2.2.16ResultSet使用next时，需要判断是否具有记录再进行一下步操作。 25 2.2.17字符串使用相应的规则。 (25) 2.2.18禁止直接调用 System.gc(),System.getRuntime().gc(),System.runFinalization()。 (27) 2.2.19finalize相应的规则。 (27) 2.2.20禁止在代码中使用System.out,ex.printStackTrace打印日志。 (28) 2.2.21系统资源释放（谁创建的，谁关闭） (29) 2.2.22使用Clone时相应的规则。 (32) 2.2.23java Bean类必须实现Serialize接口。 (33)
JAVA代码规范
Java代码规范 1. 标识符命名规范 1.1 概述 标识符的命名力求做到统一、达意和简洁。 1.1.1 统一 统一是指，对于同一个概念，在程序中用同一种表示方法，比如对于供应商，既可以用supplier，也可以用provider，但是我们只能选定一个使用，至少在一个Java项目中保持统一。统一是作为重要的，如果对同一概念有不同的表示方法，会使代码混乱难以理解。即使不能取得好的名称，但是只要统一，阅读起来也不会太困难，因为阅读者只要理解一次。 1.1.2 达意 达意是指，标识符能准确的表达出它所代表的意义，比如：newSupplier, OrderPaymentGatewayService等；而supplier1, service2，idtts等则不是好的命名方式。准确有两成含义，一是正确，而是丰富。如果给一个代表供应商的变量起名是order，显然没有正确表达。同样的，supplier1, 远没有targetSupplier意义丰富。 1.1.3 简洁 简洁是指，在统一和达意的前提下，用尽量少的标识符。如果不能达意，宁愿不要简洁。比如：theOrderNameOfTheTargetSupplierWhichIsTransfered 太长，transferedTargetSupplierOrderName则较好，但是transTgtSplOrdNm就不好了。省略元音的缩写方式不要使用，我们的英语往往还没有好到看得懂奇怪的缩写。 1.1.4 骆驼法则 Java中，除了包名，静态常量等特殊情况，大部分情况下标识符使用骆驼法则，即单词之间不使用特殊符号分割，而是通过首字母大写来分割。比如: supplierName, addNewContract，而不是supplier_name, add_new_contract。 1.1.5 英文vs 拼音
Java编程规范试题
姓名： ____________ 工号：_______________ 部门：____________ 成绩： 一. 判断题(共15题，每题2分，直接在括号内打“/或“X”) 1、任何时候都不要使接口可以序列化。x 2、相对独立的程序块之间、变量说明之后必须加空行。V 3、当程序需要释放对象的时候，应该手工调用fin alize 方法以释放对象。x 4、公司的规范要求注释率是20%以上，并且必须有助于对程序的阅读理解。x 5、为了程序更加简洁，我们应该尽量使用下面的方式来赋值： a = b = 1 。x 6、每个类都需要定义构建器。x 7、类名、方法名、属性名的命名，都应该使用意义完整的英文描述。V 8、main() 方法的定义是public static void main(String args[]) 。x 9、常量名应该使用全大写，英文单词之间用下划线或者-分隔开。并且，常量应该使用final static 修饰。x 10、公有方法参数名可以和属性名相同，但局部变量不能和属性名相同。V 11、一两行代码就能完成的功能没有必要编写方法实现。x 12、对于模块间接口方法的参数的合法性检查，调用者和被调用者都应该对参数进行合法性检查。 x 13、运行期异常使用RuntimeException的子类来表示，必须在方法声明上加throws子句。x非运行 期异常是从Exception继承而来的，不用在可能抛出异常的方法声明上加throws子句。x 14、使用Objectstream 的方法后，调用release()，释放对象。X 15、减小单个方法的复杂度，使用的if, while, for, switch 语句要在10个以内。V 二、单项选择题(共23题，每题2分) (c ) 1、排版时，代码缩进应该采用的方式是： (A)Tab缩进 (B)2个空格缩进
华为JAVA编程规范
1 Java 编程规范 1.1 排版 1.1.1 规则 规则1程序块要采用缩进风格编写，缩进的空格数为4个，不允许使用TAB缩进。(1.42+) 说明：缩进使程序更易阅读，使用空格缩进可以适应不同操作系统与不同开发工具。 规则2分界符（如大括号…{?和…}?）应各独占一行，同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序 或者static、,synchronized等语句块中都要采用如上的缩进方式。(1.42+) 示例: if (a>b) { doStart(); } 规则3较长的语句、表达式或参数（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐， 语句可读。(1.42+) 示例： if (logger.isDebugEnabled()) { logger.debug("Session destroyed,call-id" + event.getSession().getCallId()); } 规则4不允许把多个短语句写在一行中，即一行只写一条语句(1.42+) 说明：阅读代码更加清晰 示例：如下例子不符合规范。 Object o = new Object(); Object b = null; 规则5if, for, do, while, case, switch, default 等语句自占一行，且if, for, do, while,switch等语句的执行语句无论多少都要加括号{},case 的执行语句中如果定义变量必须加括号{}。 (1.42+) 说明：阅读代码更加清晰，减少错误产生 示例： if (a>b) { doStart(); }
JAVA开发规范文档
Java 开发规范文档 一：目的 使本组织能以标准的，规范的方式设计和编码。通过建立编码规范，以使每个开发人员养成良好的编码风格和习惯；并以此形成开发小组编码约定，提高程序的可靠性，可读性，可修改性，可维护性和一致性等，增进团队间的交流，并保证软件产品的质量。 二：代码组织与风格 1：长度：为便于阅读和理解，单个函数的有效代码长度当尽量在100行以内（不包括注释行），当功能模块过大时往往采用使用子函数将相应的功能抽取出来，这也有利于提高代码的重用度。 2：单个类不宜过大，当出现此类过大时当将相应功能的代码重构到其他类中，通过组合等方式来调用，建议单个类的长度包括注释行不超过1500行。尽量避免使用大类和长方法。3：间隔：类，方法及功能块间等应以空行相隔，以增加可读性，但不得有无规则的大片空行。操作符两端应当各空一个字符以增加可读性。 三：注释 1：注释应该增加代码的清晰度。代码注释的目的时要使代码更易于被其他开发人员等理解。2：保持注释的简洁。 3：注释信息应该包括代码的功能。 4：除变量定义等较短语句的注释使用行尾注释外，其他注释当避免使用行尾注释。 5：JavaDoc规范 对类，方法，变量等注释需要符合javadoc规范，对每个类，方法都应详细说明其功能条件，参数等。类注释中应当包含版本和作者信息。 1）类，接口注释在类，接口定义之前当对其进行注释，包括类，接口的目的，作用，功能，继承于何种父类，实现的接口，实现的算法，使用方法，示例程序等。 2）方法注释以明确该方法功能，作者，各参数含义以及返回值等。
3）其他注释应对重要的变量及不易理解的分支条件表达式加以注释，以说明其含义等。四命名规范 1：对变量，类，接口及包的命名应该使用英文。严禁使用汉语拼音及不相关单词命名。更不可以使用汉字来进行命名。采用大小写混合，提高名字的可读性。一般应该采用小写字母，但时类和接口的名称的首字母，以及任何中间单词的首字母应该大写。包名全部小写。 2：尽量少用缩写，但如果一定要用，当使用公共缩写和习惯缩写等，如implement可缩写为impl，manager可缩写成mgr等。 3：包名一般以项目或模块名命名，少用缩写和长名，一律小写。 包名按照如下规定组成[基本包].[项目名].[模块名].[子模块名].…. 如：org.skyinn.skyhome.dao.hibernate。 不得将类直接定义在基本包下，所有项目中的类，接口等都当定义在各自的项目和模块包中。 4：类，接口所有单词首字母大写，最好能够见名知意。一般采用名词。接口可带I前缀。 或able，dao后缀。 5：字段常量采用完整的英文大写单词，单词之间用下划线连接，如DEFAULT_V ALUE. 6：变量和参数对不易识别出该变量类型的变量应使用类型缩写作其前缀，如字符串使用strXXX，boolean使用isXXX，hasXXX等等。除第一个单词外其余单词的首字母大写。7：集合采用复数名称来表示队列中存放的对象类型，名词采用完整的英文描述。 例如：Vector vProducts= new Vector(); Array aryUsers= new Array(); 8：方法方法的名称应采用完整的英文描述，大小写混合使用：所有中间单词的第一个字母大写。方法名称的第一个单词常常采用一个强烈动作色彩的动词。取值类使用get前缀，设置类使用set前缀。例如getName（），setSarry（）。 9：异常类名由表示该异常类型的单词和Exception组成，如ActionException。异常实例一般使用e，ex等。 10：数组的命名 数组应该总是用下面的方式来命名：byte[] buffer; 而不是：byte buffer[]; 五：类与接口 1：基本原则：一个类只做一件事情。另一个原则时根据每个类的职责进行划分，比如用User 来存放用户信息，而用UserDAO来对用户信息进行数据访问操作，用UserServer对用户信息的业务操作等等。多个类中使用相同方法时将其方法提到一个接口中或使用抽象类，尽量提高重用度。不希望被实例化的类的缺省构造方法声明为private。 2：一般而言，接口定义行为，而抽象类定义属性和共有行为，注意2者的取舍，在设计中可由接口定义公用的行为，由一个抽象类来实现其部分或全部方法，以给子类提供统一的行为为定义。 六：方法 一个方法只完成一项功能。方法参数类型和参数返回值尽量接口化，以屏蔽具体的实现细节，提高系统的可扩展性，例如：public void addUser（List userList）{} public List listAllUsers（）{} 七：Web 命名规范 一：jsp页面命名 对于某个功能块的增删改查页面定义，最好使用
软件系统JAVA开发编码规范V1.0
软件系统JAVA 编码规范 版本V1.0
文档信息： 内容范围： 本文档是软件系统JAVA编码规范。适用的对象： 公司相关技术人员。
目录 1 介绍（INTRODUCTION） (5) 2 2 文件名（FILE NAMES） (6) 2.1文件后缀（F ILE S UFFIXES） (6) 2.2常用文件名（C OMMON F ILE N AMES） (6) 3 文件组织（FILE ORGANIZATION） (7) 3.1J AVA源文件（J AVA S OURCE F ILES） (7) 3.1.1开首注释（B EGINNING C OMMENTS） (7) 3.1.2包和引入语句（P ACKAGE AND I MPORT S TATEMENTS） (8) 3.1.3类和接口声明（C LASS AND I NTERFACE D ECLARATIONS） (8) 4 缩进排版（INDENTATION） (9) 4.1行长度（L INE L ENGTH） (9) 4.2换行（W RAPPING L INES） (9) 5 注释（COMMENTS） (13) 5.1实现注释的格局（I MPLEMENTATION C OMMENT F ORMATS） (13) 5.1.1块注释（B LOCK C OMMENTS） (13) 5.1.2单行注释（S INGLE-L INE C OMMENTS） (14) 5.1.3尾端注释（T RAILING C OMMENTS） (15) 5.1.4行末注释（E ND-O F-L INE C OMMENTS） (15) 5.2文档注释（D OCUMENTATION C OMMENTS） (16) 6 声明（DECLARATIONS） (17) 6.1每行声明变量的数量（N UMBER P ER L INE） (17) 6.2初始化（I NITIALIZATION） (17) 6.3布局（P LACEMENT） (17) 6.4类和接口的声明（C LASS AND I NTERFACE D ECLARATIONS） (18) 7 语句（STATEMENTS） (20) 7.1简单语句（S IMPLE S TATEMENTS） (20) 7.2复合语句（C OMPOUND S TATEMENTS） (20)
华为Java语言编码规范标准
Java语言编码规范 Prepared by 拟制Date 日期 yyyy-mm-dd Reviewed by 评审人Date 日期 yyyy-mm-dd Approved by 批准Date 日期 yyyy-mm-dd
Revision Record 修订记录
Table of Contents 目录 1. 范围 (4) 2. 规范性引用文件 (4) 3. 术语和定义 (4) 4. 排版规范 (5) 4.1. 规则 (5) 4.2. 建议 (7) 5. 注释规范 (9) 5.1. 规则 (9) 5.2. 建议 (15) 6. 命名规范 (17) 6.1. 规则 (17) 6.2. 建议 (18) 7. 编码规范 (20) 7.1. 规则 (20) 7.2. 建议 (24) 8. JTEST规范 (26) 8.1. 规则 (26) 8.2. 建议 (27)
1.范围 本规范规定了使用Java语言编程时排版、注释、命名、编码和JTEST的规则和建议。 本规范适用于使用Java语言编程的产品和项目。 2.规范性引用文件 下列文件中的条款通过本规范的引用而成为本规范的条款。凡是注日期的引用文件，其随后所有的修改单（不包括勘误的内容）或修订版均不适用于本规范，然而，鼓励根据本规范达成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件，其最新版本适用于本规范。 3.术语和定义 规则：编程时强制必须遵守的原则。 建议：编程时必须加以考虑的原则。 格式：对此规范格式的说明。 说明：对此规范或建议进行必要的解释。 示例：对此规范或建议从正、反两个方面给出例子。
JAVA开发规范
1.编程规范 (一)命名规范 1.【强制】所有编程相关的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束 反例：_name / name_ / $name / name$ 正例：name 2.【强制】所有编程相关的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。 说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用。 反例：XingMing [姓名] /xingBie() [性别] 正例：name[姓名] sex[性别]等国际通用的名称，可视为英文。 3. 【强制】类名使用UpperCamelCase(第一个词的首字母，以及后面每个词的首字母都大写，叫做“大骆驼拼写法”) 风格，必须遵从驼峰形式，但以下情形例外：（领域模型的相关命名）DO / DTO / VO / DAO 等。正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion 反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion
4. 【强制】方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase (第一个词的首字母小写，后面每个词的首字母大写，叫做“小骆驼拼写法”)风格，必须遵从驼峰形式。 正例： localValue / getHttpMessage() / inputUserId 5. 【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。 正例： MAX_STOCK_COUNT 反例： MAX_COUNT 6. 【强制】抽象类命名使用 Abstract或Base 开头；异常类命名使用 Exception结尾；测试类命名以它要测试的类的名称开始，以 Test 结尾。 7. 【强制】中括号是数组类型的一部分，数组定义如下：String[] args; 请勿使用String args[]的方式来定义 8. 【强制】POJO类中的任何布尔类型的变量，都不要加 is，否则部分框架解析会引起序列化错误。 反例：定义为基本数据类型 boolean isSuccess；的属性，它的方法也是isSuccess()，RPC框架在反向解析的时候，“以为”对应的属性名称是 success，导致属性获取不到，进而抛出异常。
java编码规范考试题答案
一、单选题 1. 如下关于集合类的描述错误的是B A. 含有集合意义的属性命名，尽量包含其复数的意义 B. 集合中的数据不需要释放，垃圾回收器会自动回收 C. 集合必须指定模板类型 D. 使用集合类时要设置初始化容量 2. 关于线程以下说法错误的有B A. 新起一个线程，都要使用Thread.setName(“…”)设置线程名 B. 在JDK1.5或更新的版本中，若字符串拼接发生在单线程环境，使用StringBuffer C. 对多线程访问的变量、方法，必须加锁保护，避免出现多线程并发访问引起的问题 D. 线程使用时，要在代码框架中使用线程池，避免创建不可复用的线程；禁止在循环中创建新线程，否则会引起JVM资源耗尽 3. 下面哪个是推荐使用的对称密码算法B A. DES B. AES C. SHA D. RSA
4. 以下说法正确的有C A. 程序中的一些状态多直接用数字表示，如函数执行成功return 1 B. 对于表示函数执行错误，多用约定的错误码来标识 C. 用有意义的静态变量或者枚举来代替数字型的程序状态，如函数执行成功return SUCCESS D. 程序中的魔鬼数字并不可怕，需要所有开发人员努力理解这些数字的含义 5. 下列错误使用异常的做法是D A. 在程序中使用异常处理还是使用错误返回码处理，根据是否有利于程序结构来确定，并且异常和错误码不应该混合使用，推荐使用异常 B. 一个方法不应抛出太多类型的异常。throws/exception子句标明的异常最好不要超过三个 C. 异常捕获尽量不要直接catch (Exception ex)，应该把异常细分处理 D. 程序内抛出的异常本身就可说明异常的类型、抛出条件，可不填写详细的描述信息。捕获异常后用exception.toString()取到详细信息后保存 6. 关于命名规范，以下说法错误的有D A. 属性名使用意义完整的英文描述，第一个单词的字母使用小写，剩余单词首字母大写其余字母小写的大小写混合法。属性名不能与方法名相同 B. 方法名使用类意义完整的英文描述：第一个单词的字母使用小写、剩余单词首字母大写其余字母小写的大小写混合法 C. 方法中，存取属性的方法采用setter 和getter方法，动作方法采用动词和动宾结构
JAVA源代码规范
JAVA代码规范 (初稿) 2004、4 ?版本更新信息 本版本创建/修改、维护、批准涉及人员如下： 创建/修改者：XX 维护者：XX 批准者：XX 具体版本更新记录如表1-1： 表1-1 版本更新记录 修改方式：A－增加 M－修改 D－删除?目得 本文提供一整套编写高效可靠得 Java 代码得标准、约定与指南。它们以安全可靠得软件工程原则为基础，使代码易于理解、维护与增强灵活性。通过遵循一套通用得程序设计标准，显著提高 Java 软件开发者得生产效率，为开发团队得程序设计带来更大得一致性，使软件开发团队得效率明显提高。 ?规范得执行 本文档适用于公司内进行软件开发得所有技术人员，即公司内软件开发人员编写得所有源代码都必须遵循本规范。 除临时性项目之外得任何项目均应严格按照此标准执行，“临时性项目”指：?为市场推广目得而编写得示程序 ?为一次性用途而编写得临时性小程序 为学习目得而编写得测试程序 ?文档类别
本文档属标准规范类得项目限制级文档，未经总经理及总经理授权人员批准，不得提供公司以外得人员阅读与使用。 ?版本更新条件 本文档得定期评审时间为每年得1月，评审及修订步骤依据SEPG工作规范规定。此外，如遇下列条件可进行评审，并根据评审结果决定就是否需要进行修订： ?本文档所列得引用得标准已经更新。 ?本文档得使用者若对本文档有任何评论、建议或意见，请通过企业内部网络发电子邮件给SEPG，所收到得电子邮件将会在评审与修订时给予充分 得考虑。 ?使用对象 本文档得使用对象包括： ?项目管理者 ?质量保证人员 ?软件开发人员 目录 1介绍 (4) 1、1为什么要有编码规范 (4) 2通用代码格式 (4) 2、1文件组织 (4) 2、2缩进 (5) 2、3行长度 (6) 2、4换行 (6) 2、5空行 (7) 2、6空格 (7) 2、7注释 (8) 2、7、1注释约定 (8) 2、7、2实现注释得格式 (9) 2、7、3文档注释 (10) 2、7、4快速浏览javadoc (10) 2、8声明 (11) 2、8、1每行声明变量得数量 (11) 2、8、2初始化 (11) 2、8、3布局 (11) 2、8、4类与接口得声明 (12) 2、9语句 (12) 2、9、1简单语句 (12) 2、9、2复合语句 (13) 2、9、3返回语句 (13) 2、9、4if，if-else，if else-if else语句 (13)
java项目团队开发规范
项目团队开发规范
修订历史记录
目录 1引言 (6) 1.1 编写目的 (6) 1.2 预期读者 (6) 1.3 编写背景 (6) 2概述 (7) 2.1 目标 (7) 2.2 修改及完善 (7) 3详细规范 (7) 3.1 使用的工具 (7) 3.2 框架设计 (7) 3.3 包目录 (8) 3.4 编码规范 (10) 3.4.1 目的 (10) 3.4.2 依据 (10) 3.4.3 具体规范 (10) 3.4.3.1 编码风格 (10) 3.4.3.1.1 缩进 (10) 3.4.3.1.2 空格 (11) 3.4.3.1.3 对齐 (12) 3.4.3.1.4 空行 (12)
3.4.3.1.5 代码长度 (13) 3.4.3.1.6 行数 (13) 3.4.3.1.7 注释 (14) 3.4.3.2 代码效率 (17) 3.4.3.2.1 综述 (17) 3.4.3.2.2 具体实现 (17) 3.4.3.3 异常处理 (17) 3.4.3.3.1 处理CHECK 异常与UNCHECK异常 (17) 3.4.3.4 程序调试 (17) 3.4.4 日常交流 (18) 3.4.4.1 互相促进 (18)
1引言 1.1 编写目的 本文档作为项目团队开发规范的说明书，描述了项目开发过程中的使用的工具，框架，代码编写规范及注意问题，作为项目团队建设，开发及测试工作的依据。 1.2 预期读者 本文档的预期读者包括以下几类： ?项目组长 ?项目组全体成员 1.3 编写背景 根据公司现有的开发状况，决定组件稳定的项目开发团队，制定全体团队成员共识的开发规范，有助于提高项目开发的效率、项目团队整体水平的提升。
Java编程规范
Java编程规范本文引用阿里Java开发手册。GitHub阅读地址： 目录 编程规约 - 命名规约 - 常量定义 - 格式规范 - OOP规约 - 集合处理 - 并发处理 - 控制语句 - 注释规约 - 其他 - 异常处理 - 建表规约 - 索引规约 - SQL规约
- ORM规约 编程规约 命名规约 1、【强制】所有编程相关命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束 反例： _name / __name / $Object / name_ / name$ / Object$1 2、【强制】所有编程相关的命名严禁使用拼音与英语混合的方式，更不允许直接使用中的方式。 说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即纯拼音的命名方式也要避免采用。 反例： DaZhePromotion [打折] / getPingfenByName() [评分] / int 变量 = 3; 正例： ali / alibaba / taobao / cainiao / aliyun / youku / hangzhou 等国际通用的名称，可视为英文。12345 3、【强制】类名使用 UpperCamelCase 风格，必须遵从驼峰形式，但以下情形例外：（领域模型的相关命名） DO / DTO / VO / DAO 等。 正例： MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion 反例： macroPolo / UserDo / XMLService / TCPUDPDeal
/ TAPromotion123 4、【强制】方法名、参数名、成员变量、局部变量都统一只用 lowerCamelCase 风格，必须遵从驼峰形式。 正例： localValue / getHttpMessage() / inputUserId1 5、【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。 正例： MAX_STOCK_COUNT 反例： MAX_COUNT123 6、【强制】抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类命名以它要测试的类的名称开始，以 Test 结尾。 7、【强制】中括号是数组类型的一部分，数组定义如下：String[] args ; 反例：请勿使用 String args[] 的方式来定义1 8、【强制】 POJO 类中的任何布尔类型的变量，都不要加 is，否则部分框架解析会引起序列化错误。 反例：定义为基本数据类型 boolean isSuccess；的属性，它的方法也是 isSuccess()， RPC框架在反向解析的时候，“以为”对应的属性名称是 success，导致属性获取不到，进而抛出异常。1 9、【强制】包名统一使用小写，点分隔符之间有且仅有一
(完整版)阿里巴巴编码规范(Java)题库
多选 1.如何处理单元测试产生的数据，下列哪些说法是正确的？ABC A .测试数据入库时加特殊前缀标识。 B .测试数据使用独立的测试库。 C .自动回滚单元测试产生的脏数据。 D .无须区别，统一在业务代码中进行判断和识别。 多选 2.关于并发处理，下列哪些说法符合《阿里巴巴Java开发手册》：ABC A .线程资源必须通过线程池提供，不允许在应用中自行显式创建线程。 B .同步处理时，能锁部分代码区块的情况下不要锁整个方法；高并发时，同步调用应该考虑到性能损耗。 C .创建线程或线程池时，推荐给线程指定一个有意义的名称，方便出错时回溯。 D .推荐使用Executors.newFixedThreadPool(int x)生成指定大小的线程池。(线程池不允许使用 Executors 去创建，而是通过 ThreadPoolExecutor 的方式) 多选 3.下列哪些说法符合《阿里巴巴Java开发手册》：ACD A .对于“明确停止使用的代码和配置”，如方法、变量、类、配置文件、动态配置属性等要坚决从程序中清理出去，避免造成过多垃圾。 B .永久弃用的代码段注释掉即可，即不用加任何注释。 C .对于暂时被注释掉，后续可能恢复使用的代码片断，在注释代码上方，统一规定使用三个斜杠(///)来说明注释掉代码的理由。 D .不要在视图模板中加入任何复杂的逻辑。 多选 4.关于分页查询，下列哪些说法符合《阿里巴巴Java开发手册》：ABC A .分页查询，当统计的count为0时，应该直接返回，不要再执行分页查询语句。 B .iBATIS自带的queryForList(String statementName,int start,int size)分页接口有性能隐患，不允许使用。 C .定义明确的sql查询语句，通过传入参数start和size来实现分页逻辑。 D .可使用存储过程写分页逻辑，提高效率。
Java编程要求规范精彩试题
JAVA编程规范--试题 姓名：工号：部门：成绩： 一. 判断题（共15题，每题2分，直接在括号内打“√”或“×”） 1、任何时候都不要使接口可以序列化。x 2、相对独立的程序块之间、变量说明之后必须加空行。√ 3、当程序需要释放对象的时候，应该手工调用finalize方法以释放对象。x 4、公司的规范要求注释率是20％以上，并且必须有助于对程序的阅读理解。x 5、为了程序更加简洁，我们应该尽量使用下面的方式来赋值：a = b = 1 。x 6、每个类都需要定义构建器。x 7、类名、方法名、属性名的命名，都应该使用意义完整的英文描述。√ 8、main() 方法的定义是public static void main(String args[])。x 9、常量名应该使用全大写，英文单词之间用下划线或者-分隔开。并且，常量应该使用 final static修饰。x 10、公有方法参数名可以和属性名相同，但局部变量不能和属性名相同。√ 11、一两行代码就能完成的功能没有必要编写方法实现。x 12、对于模块间接口方法的参数的合法性检查，调用者和被调用者都应该对参数进行合 法性检查。x 13、运行期异常使用RuntimeException的子类来表示，必须在方法声明上加throws子句。 x非运行期异常是从Exception继承而来的，不用在可能抛出异常的方法声明上加throws 子句。x 14、使用ObjectStream 的方法后，调用release() ，释放对象。X 15、减小单个方法的复杂度，使用的 if, while, for, switch 语句要在10个以内。√ 二、单项选择题(共23题，每题2分) （ c ）1、排版时，代码缩进应该采用的方式是： （A）Tab缩进 （B）2个空格缩进 （C）4个空格缩进 （D）8个空格缩进
Java代码编写规范(参考)
命名规范： 1.所有的标识都只能使用ASCII字母（A-Z或a-z）、数字（0-9）和 下划线”_”。 2.一个唯一包名的前缀总是用全部小写的字母。 3.类名是一个名词，采用大小写混合的方式，每个单词的首字母大 写。 4.接口的大小写规则与类名相似。 5.方法名是一个动词或是动词词组，采用大小写混合的方式，第一 个单词的首字母小写，其后单词的首字母大写。 6.变量名的第一个字母小写，任何中间单词的首字母大写，变量名 应简短且可以顾名思义，易于记忆。避免单个字符的变量名，除非是一次性的临时变量。 7.常量的声明应该全部大写，每个单词之间用”_”连接。 注释规范： 1.注释尽可能使用”//”,对于所有的Javadoc的注释使用/***/，而 临时对代码块进行注释应尽量使用/**/。 2.所有的源文件都应该在开头有一个注释，其中列出文件名、日期 和类的功能概述。每个方法必须添加文档注释（main除外）。 3.每个属性必须加注释。 4.代码中至少包含15%的注释。 5.注释使用中文。
缩进排版规范： 1.避免一行的长度超过60个字符。 2.使用Eclipse源代码的格式化功能完成代码的缩进排版。 文件名规范： 1.一个Java源文件只能储存一个Java类。 2.文件名与Java类相同。 3.一个类文件不超过200行。 声明规范： 1.一行声明一个变量。 2.不要将不同类型变量的声明放在同一行。 3.只在代块的开始处声明变量。 4.所有的变量必须在声明时初始化。 5.避免声明的局部变量覆盖上一级声明的变量。 6.方法与方法直接以空行分隔。 语句规范： 1.每行至少包含一条简单语句。 2.在return语句中，返回值不使用小括号”()”括起来。 3.If月总是用{和}括起来。 4.在for语句的初始化或者更新子句中，避免因使用3个以上变量， 而导致复杂度提高。 5.当switch的一个case顺着往下执行时（因为没有break），通常 应在break语句的位置添加注释。
华为JAVA编码规范
1.程序块采用缩进风格,空格为4个. 说明: 对于开发工具自动生成的代码可以不一致 2.分界符(如大括号{和})应各自占一行并且在同一列,同时与引用它们的语句左 对齐,在方法的开始,类和接口的定义,以及if,for,do,while,switch,case语句都要采用上述缩进 说明: for(…) { …//your code } 3.较长(>80字符)的语句,表达式和参数要分多行,长表达式要在低优先级操作符 划分新行,操作符放在行首,新行要适当缩进,整齐,语句可读. 说明: if(filename != null && new File(logPath+filename).length() < logConfig.getFileSize()) { …//your code } 4.一行只写一条语句 说明: LogFilename wow = null; LogFilename that = null; 5.if,for,do,switch,while,case,default各占一行,它们的执行语句无论多少都要加{} 说明: if(writeToFile) { writeFileThread.interrupt(); } 6.相对独立的程序块,变量,说明要加空行 说明: if(log.getLevel() < log.getRecord()) { return ; } //空行
LogWrite writer; 7.对齐只用空格键,不用TAB键 说明: 以免使用不同的编辑器阅读程序时,因TAB键所设置的空格数不同而造成程序布局不整齐,JBuildr,UltraEdit等编辑环境,支持行首TAB替换成空格,应将该选项打开 8.两个以上的关键字,变量,常量进行对等操作时,操作符之前,之后或前后要加空 格,进行非对等操作时,如果是关系密切的立即操作符,后面不加空格(如.操作符) 说明: 采用这种松散方式编写代码目的是让程序更加清晰,由于空格所产生的清晰性是相对的,所以在已经很清晰的语句中没有必要留空格,如果语句已足够清晰,则括号内侧(即左括号后面和右括号前面)不需要加空格,多重括号间不必加空格,因为java中括号已经是很清晰的标志了.在长句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部中不加空格,给操作符留空格时不要连续留两个以上空格 9.类属性和方法不要交叉放置,不同存取范围的属性和方法也不要交叉放置 说明: 类定义:{ 类公有属性定义; 类保护属性定义; 类私有属性定义; 类公有方法定义; 类保护方法定义; 类私有方法定义; } 10.源程序的有效注释量必须在30%以上 11.包的注释写入一个名为package.html的html格式的说明文件放入当前路径 12.包的注释内容:本包作用,详细描述本包内容,产品模块名称及版本,公司版本 说明:
一句话描述 详细描述 产品模块公司版本信息
java开发规范文档
一千零一夜产品部系统开发规范V1.0 一千零一夜途遇科技有限公司 2015-11-03
修改记录 目录 1前言 (4) 2开发管理 (4) 3项目周期 (4) 4命名规范 (5) 4.1项目编号命名规范 (5) 4.2文档命名规范 (5) 4.3路径管理 (5) 4.4jsp/html命名规范 (6) 4.5数据库命名规范 (8) 4.5.1表名规范 (8) 4.5.2字段规范 (8) 5文档规范 (8) 6代码规范 (9) 6.1Java源代码规范 (9) 6.1.1命名 (9) 6.1.2代码格式 (11) 6.1.3注释 (12) 6.1.4其他 (13) 6.2jsp/html代码规范 (13) 6.3数据库开发规范 (15) 6.3.1主键 (15) 6.3.2日期类型 (16) 6.3.3固定字段 (16) 6.3.4取值规范 (16) 6.3.5数据库开发工具 (16)
6.3.6Sql书写规范 (17) 6.4其他规范 (17) 7实战代码规范 (18) 7.1Java源代码规范 (18) 7.1.1java代码命名与格式 (18) 7.2jsp/html代码规范 (26) 8FAQ (29) 8.1Logic类中新增数据方法怎么写 (29) 8.2Logic类中修改数据方法怎么写 (30) 8.3Logic类中删除数据方法怎么写 (31) 8.4怎样创建一个没有底部按钮的窗口 (32) 8.5怎样设置弹出窗口的标题 (32) 8.6怎样重写提交数据的方法 (33) 8.7怎样创建单grid的页面 (33) 8.8怎样多个页签的grid的页面 (34) 8.9怎样创建左边树右边grid的页面 (34) 9代码检查规定 (34) 10附录1：JPA使用指南javax.persistence的注解配置 (34)
(完整word版)JAVA代码规范详细版
JAVA代码规范 本Java代码规范以SUN的标准Java代码规范为基础，为适应我们公司的实际需要，可能会做一些修改。本文档中没有说明的地方，请参看SUN Java标准代码规范。如果两边有冲突，以SUN Java标准为准。 1. 标识符命名规范 1.1 概述 标识符的命名力求做到统一、达意和简洁。 1.1.1 统一 统一是指，对于同一个概念，在程序中用同一种表示方法，比如对于供应商，既可以用supplier，也可以用provider，但是我们只能选定一个使用，至少在一个Java项目中保持统一。统一是作为重要的，如果对同一概念有不同的表示方法，会使代码混乱难以理解。即使不能取得好的名称，但是只要统一，阅读起来也不会太困难，因为阅读者只要理解一次。 1.1.2 达意 达意是指，标识符能准确的表达出它所代表的意义，比如：newSupplier, OrderPaymentGatewayService等；而supplier1, service2，idtts等则不是好的命名方式。准确有两成含义，一是正确，而是丰富。如果给一个代表供应商的变量起名是order，显然没有正确表达。同样的，supplier1, 远没有targetSupplier意义丰富。 1.1.3 简洁 简洁是指，在统一和达意的前提下，用尽量少的标识符。如果不能达意，宁愿不要简洁。比如：theOrderNameOfTheTargetSupplierWhichIsTransfered 太长，transferedTargetSupplierOrderName则较好，但是transTgtSplOrdNm就不好了。省略元音的缩写方式不要使用，我们的英语往往还没有好到看得懂奇怪的缩写。 1.1.4 骆驼法则 Java中，除了包名，静态常量等特殊情况，大部分情况下标识符使用骆驼法则，即单词之间不使用特殊符号分割，而是通过首字母大写来分割。比如: supplierName, addNewContract，而不是supplier_name, add_new_contract。
javaweb开发规范
Java web开发规范 1、前言 为了使软件开发过程有章可循，保证软件质量，加强开发管理。 2、开发管理 项目进度周报表格如下： 项目编号汇报人汇报日期项目进度详细描述其他问题 3、命名规范 3.1项目编号命名规范 命名方式：项目英文/中午拼音名称_开发组编号_序列号 序列号由3为数字组成，不足的用’0’补齐。 3.2文档命名规范 命名方式：项目英文/中午拼音名称_文档名称_序列号_编写人名称/编号 3.3jsp/html命名规范 1、jsp与html文件名全部小写，并遵循如下的规范： a.数据/内容显示页: 名词，多个单词用下划线分隔，要求能说明显示内容的信息，为避免冲突，可加上“_list”。例如： new_message.html或my_file_list.jsp b.操作处理页 命名格式：名词_下划线_动词，例如：file_delete.jsp。 c.含frame页面