当前位置:首页 > 开发 > 系统架构 > 架构 > 正文

java基本规范

发表于: 2012-12-19   作者:cuiyaoonan2000   来源:转载   浏览:
摘要: 1 格式与命名规范 1.1  缩进 缩进应该是每行2个空格。 不要在源文件中保存Tab字符, 在使用不同的源代码管理工具时Tab字符将因为用户设置的不同而扩展为不同的宽度。 1.2 换行  每行代码最长统一设置成120个字符。(可以通过开发工具进行长度限制。如图1,Myelipse8.5设置方法) (图1)  If(),for(),while(),try(),catc
1 格式与命名规范
1.1  缩进
缩进应该是每行2个空格。 不要在源文件中保存Tab字符, 在使用不同的源代码管理工具时Tab字符将因为用户设置的不同而扩展为不同的宽度。
1.2 换行
 每行代码最长统一设置成120个字符。(可以通过开发工具进行长度限制。如图1,Myelipse8.5设置方法)

(图1)
 If(),for(),while(),try(),catch(),finally()等关键字建议都需要单独占用一行。
1.3 命名规则
 包名:采用完整的英文描述符,应该都是由小写字母组成。对于全局包,将你的 Internet 域名反转并接上包名。如:com.jinmajia.www.domain
 类名: 采用完整的英文描述符,所有单词的第一个字母大写。如:public class LoginIn{}.
 接口:采用完整的英文描述符说明接口封装,所有单词的第一个字母大写。
 变量名:字段采用完整的英文描述,第一个字母小写,任何中间单词的首字母大写。如:int countPeople;
 方法名:英文首字母小写,其余单词首字母大些,并按功能取名。如:int void findUserById()。
 JSP文件命名:采用完整的英文描述说明JSP所完成的功能,尽可能包括一个生动的动词,第一个字母小写,如:viewMessage.jsp。
 获取成员方法名:被访问字段名的前面加上前缀 get。如:getFirstName()。布尔型的获取成员函数,所有的布尔型获取函数用单词 is 做前缀。 isPersistent()。
 常量名:静态常量字段全部采用大写字母,单词之间用 下划线 分隔。。如:public static final Int ALL_NUMBER = 1。
 数据库表名:英文小写,多个单词用 下划线 分开,并按功能取名。如:user_order表。
 循环计数器变量: 建议采用字母 i,j,k 或者 counter。
2注释规范
2.1 注释要求
 注释应该增加代码的清晰度
 保持注释的简洁
 在写代码之前写注释
 注释出为什么做了一些事,而不仅仅是做了什么
2.2类文件开头注释
该注释可以自动生成,如下为MyEclipse的统一设置
/**
* fileName:${file_name}
* description:这里添加类描述
* author:cuiyaonan email:cuiyaonan2000@163.com
* createDate:${date}
*/
2.3 方法头注释
该注释可以自动生成,如下为MyEclipse的统一设置
/**
* description: 这里添加方法功能描述
* author:cuiyaonan email:cuiyaonan2000@163.com
* createDate:${date}
*/

2.4失效代码注释
  由/*...*/界定,标准的C-Style的注释。专用于注释已失效的代码。(非/** */注释)
/*
* int a = 1;
* System.out.println(a);
*/
2.5代码内部注释
//:在成员函数内采用单行注释,来说明业务逻辑、代码段和暂时变量的声明。注释符"//"后必须紧跟一个空格,然后才是注释信息。
3编程规范
3.1基本规范
 隐藏工具类的构造器,确保只有static方法和变量的类不能被构造
 变量定义尽量基于接口而不是具体实现类,如Map map = new HashMap()
 代码中不能使用System.out.println(),e.printStackTrace(),必须使用logger打印信息。 或者其他的异常处理机制。
 左括号和后一个字符之间不应该出现空格; 同样, 右括号和前一个字符之间也不应该出现空格。
 在处理 String 的时候要尽量使用 StringBuffer 类。
 避免使用索引来调用数据库中间层组件返回的结果集。
3.2 异常处理
 重新抛出的异常必须保留原来的异常,即throw new NewException("message",e); 而不能写成throw new NewException("message")。
 在异常被捕获且没有重新抛出的地方须写日志或录入数据库。 
 框架尽量捕获低级异常,并封装成高级异常重新抛出,隐藏低级异常的细节。
3.3 代码度量
3.3.1方法度量
 方法(构造器)参数在7个以内。(可以放入集合传递,推荐用Map key表示功能 value代表值)
 方法长度150行以内 (方法如过长可以拆分成不同功能的方法)
 方法能够抽离出来作为工具的尽量抽离出来
 方法内建议不要使用递归算法。
3.3.3 其他度量
 布尔表达式中的布尔运算符(&&,||)的个数不超过3个
 if语句的嵌套层数3层以内
 类文件长度2000行以内(如类文件长度超过2000行,建议拆分成不同的类,类似拆分方法)
 匿名内部类建议20行以内 
4开发环境统一
同一个项目建议统一如下内容:
 开发工具版本,如Myeclipse8.5
 Web服务器版本,如:Tomcat6.5
 测试数据库版本
 JDK版本,如JDK6。以及其他jar包版本。
 编码格式(utf-8)。包括tomact,Myeclipse,数据,视图展现层(如jsp)

java基本规范

  • 0

    开心

    开心

  • 0

    板砖

    板砖

  • 0

    感动

    感动

  • 0

    有用

    有用

  • 0

    疑问

    疑问

  • 0

    难过

    难过

  • 0

    无聊

    无聊

  • 0

    震惊

    震惊

版权所有 IT知识库 CopyRight © 2009-2015 IT知识库 IT610.com , All Rights Reserved. 京ICP备09083238号