云课堂大型项目软件工程代码界面.pdfVIP

Java代码和界面规范

第部分的

一.为了统一公司软件开发设计过程的编程规范

二.使开发人员能很方便的理解每个，变量，控件，类，方法的意义

三.为了保证编写出的程序都符合相同的规范，保证一致性、统一性而建立的程序编码规范。

四.编码规范和约定必须能明显改善代码可读性，并有助于代码管理、分类范围适用于企业所有

基于Java平台的软件开发工作。

第部分规范细节

代码规

1.命名规范

1.1一个唯一包名的前缀总是全部小写的ASCII字母

1.2类名是一个名词，采用大小写混合的方式，每个单词的首字母大写

1.3接口的大小写规则与类名相似

1.4方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单

词的首字母大写

1.5变量名不应以下划线或符号开头,变量名应简短且富于描述,应该易于,

避免单个字符的变量名，除非是的临时变量,第一个单词的首字母小写

1.6常量的，应该全部大写

2.注释规范

2.1

所有的源文件都应该在开头有一个注释，其中列出文件名、日期和类的功能概述

2.2每个方法必须添加文档注释(类的main()方法除外)

2.3代码或者实现细节需要15%的注释量

2.4注释使用中文

3.缩进排版规范

3.1避免一行的长度超过60个字符

3.2使用Eclipse的源代码的格式化功能完成代码的缩进排版

4.文件名规范

4.1一个Java源文件只能一个Java类

4.2文件名与Java类名相同

4.3一个类文件的代码行不超过200行

5.规范

5.1一行一个变量

5.2不要将不同类型变量的放在同一行

5.3只在代码块的开始处变量

5.4避免的局部变量覆盖上一级的变量

5.5方法与方法之间以空行分隔

6.语句规范

6.1每行至多包含一条简单语句

6.2一个带返回值的return语句不使用小括号()

6.3if语句总是用{和}括起来

6.4当在for语句的初始化或更新子句中使用逗号时，避免因使用三个以上变量，而导

1

致复杂度提高

6.5每当switch的一个case顺着往下执行时(因为没有break语句)，通常应在break语句

的位置添加注释

7.编程规范

7.1提供对实例以及类变量的public或private控制,尽可能不使用缺省或protected

控制

7.2避免用一个对象一个类的静态变量和方法。应该用类名替代

7.3避免在一个语句中给多个变量赋相同的值

7.4如果使用JDBC,考虑使用java.sql.PreparedStateme