Java代码和界面规范.docVIP

Java代码和界面规范 一、目的 （1）、为了统一公司软件开发设计过程的编码规范 （2）、是网站开发人员能很方便的理解每个项目、变量、控件、类、方法的定义。 （3）、保证编写出的程序都符合相同的规范，保证一致性、统一性。 （4）、编码规范和约定必须能明显的改善代码可读性，并有助于代码管理。分类范围适用于企业所有基于java平台的软件开发。 二、规范细节 1.代码规范 1）命名规范 （1）、一个唯一包名的前缀总是全部小写的ASCII字母。 （2）、类名是一个名词，采用大小写混合的方式，每个单词的首写字母大写。 （3）、接口的大小写规则与类名相似。 （4）、方法名是一个动词，采用大小写混合的方式，第一个单词的首写字母小写，其后单词的首写字母大写。 （5）、变量名不应以下划线或美元符号开头，变量名应简短而且富于描述，应该易于记忆，避免单个字符的变量名，除非是一次性使用的临时变量，第一个单词的首写字母小写。 （6）、常量的声明，应该全部大写。 2）注释规范 （1）、所有的源文件都应该在开头有一个注释，其中列出文件名、日期和类的功能概述。 （2）、每个方法必须添加文档注释（类的mian（）方法除外）。 （3）、代码或者实现细节需要15%的注释量。 （4）、注释使用中文。 3）缩进排版规范 （1）、避免一行的长度超过60个字符。 （2）、使用Eclipse的源代码的格式化功能完成代码的缩进和排版。 4）文件名规范 （1）一个Java源文件只能存储一个Java类。 （2）文件名与Java类名相同。 （3）一个类文件的代码行不能超过200行。 5）声明规范 （1）一行声明一个变量。 （2）不要将不同的类型变量的声明放在同一行。 （3）只在代码块的开始处声明变量。 （4）避免声明的局部变量覆盖上一级声明的变量。 （5）方法与方法之间以空行分隔。 6）语句规范 （1）每行至少包含一条简单语句。 （2）一个带返回值的return语句不适用小括号“（）”。 （3）if语句总是用“ ”和“ ”括起来。 （4）当在for语句的初始化或更新子句中使用逗号时，避免因使用3个以上变量而导致复杂度提高。 （5）每当switch的一个case顺着往下执行时（因为没有break语句），通常应在break语句的位置添加注释。 7）编程规范 （1）提供对实例以及类变量的public或private访问控制，尽可能不适用默认或protected访问控制。 （2）避免用一个对象访问一个类的静态变量和方法，应该用类名代替。 （3）避免爱一个语句中给多个变量赋相同的值。 （4）如果使用JDBC，考虑使用java.sql.PreparedStatement，而不是java.sql.Statement。 2.界面规范 1）原则 （1）提供可视反馈。在后台运行长进程时（时间超过10s，视具体情况而定），必须提供进度条等信息提示。 2 保持界面能很快对用户操作做出反应。 3 提供快捷键。 4 界面应该很简单 不是过分单纯化 ，易于学习，并且易于使用。 5 界面美观，能够吸引用户。 6 对同一控件的规范要求应一致。 2 命令行程序运行界面规范 1 背景为白色，前景为黑色。 2 字体为宋体24。 3 安全性规范 当3次输入错误的验证信息后，应该禁用该用户的账户或暂时禁用。 4 界面风格 1 用户界面控件看起来应该是一致的。 2 将重要信息放在上面或左边。 3 使用做对齐来使用户界面控件更易于浏览。 4 不同界面中的同一功能应该使用同样的图标和图片。图标、图片的色调、风格尽量保持一致。 5 截屏使用JPEG格式，1024*768*32位色彩。 6 使用统一的CSS。 5 界面控件规范 （1）总结列表框提供一个标签，必须用标签来表明列表框的用途。 （2）使列表框至少5行长，少于5行的列表没有滑块，不便于滚动。 （3）将静态文本标签置于相关控件的左边，而不是上面。 （4）左对齐静态文本标签，左对齐使得标签外观更有条理，而其易于浏览。 （5）避免不好的背景，将文本放在实的、颜色适中的背景上，确保在文本和背景之间存在良好的对比。 （6）采用日期和时间拾取控件进行日期输入。 6）字体规范 字体统一使用以下设置：字符集GBK，宋体 7）界面展示规范 （1）数据按照类别显示时，每页数据不能超过10行。 （2）数据按照列表显示时，第一列为选择控件，其次为数据信息，最后为操作按钮。 8）界面操作规范 （1）对输入控件，如果没有输入，应该给出提示的消息框。 （2）对输入控件，应给出相应的必填的提示标签。 三、规范代码样列 /** * s1java.HelloAccp.java * 2007-5-8 * 第一个Java程序 */ package s1java; public cl