JAVA编码规范V讲述.docVIP

编码规范 目 录 一、 概述 7 二、 为什么要制定代码规范 7 三、 java编码规范 7 1. 文件组织 7 1.1 java源文件 7 1.2 开头注释 7 1.3 包和引入语句 8 1.4 类和接口声明 9 2 排版规范 9 2.1 行长度 10 2.2 换行 10 2.3 缩进 10 3 注释规范 10 3.1 实现注释 11 3.2 文档注释 12 4 声明 13 4.1 每行的声明数 13 4.2 初始化 13 4.3 放置 13 4.4 类和接口的声明 14 5 空白 14 5.1 空行 14 5.2 空格 15 6 函数 15 6.1 短小 15 6.2 只做一件事 16 6.3 使用描述性的名称 16 6.4 别重复自己 17 7 惯例 17 7.1 标识符 17 7.2 关键字 17 7.3 类名 17 7.4 变量名 17 7.5 常量名 17 8 Log日志 18 四、 JAVA代码性能 18 1动态BEAN的使用 18 2 StringBuffer的使用 18 3 List的使用 18 五、 JAVA框架相关 18 1文件命名及功能 18 2 Struts控制器 19 3 Struts自定义标签//需补充 19 4 Hibernate HQL语句 20 5 程序目录结构 20 6 动态BEAN的使用 20 7 AJAX交互 20 六、 JavaScript编码规范 21 1.变量命名规范 21 2.变量使用规范 21 3.对象命名规范 22 4.函数命名规范 22 5.代码规则和版式规则 22 6.注释规范 22 6.JS文件使用 22 1.页面设计部分 23 1.1 Input控件 23 1.2 Form控件 24 1.3 button控件 24 1.4 img控件 24 1.5列表表头 25 1.6列表分页 25 1.7树状结构 25 1.8时间控件 26 1.9 加载页面控件 26 1.10 附件上传控件 27 1.11 pagePresist控件 27 1.12 fileImage控件 27 1.13 selectfile控件 27 1.14 页面导航控件 27 1.15 返回按钮控件 28 1.16 省略标签控件 28 1.17 title属性 28 1.18 语言设置 28 1.19 界面刷新 29 1.20 样式表引用 29 1.21页面的布局 29 2.HTML标记语言编码规范 30 2.1 标记的换行规范 30 2.2 标记的关闭规范 30 2.3标记的属性赋值规范 30 2.4标记的缩进规范 30 3 客户端程序部分 30 3.1.提示信息的处理 30 3.2提交前数据的判断 32 3.3 删除数据前的提示 33 3.4 自动保存 33 3.5 注释 33 七、 数据库编码规范 33 1. 命名约定 33 2.一般性注释 33 3. 常用SQL 语句的编写规范 34 3.1 大小写 34 3.2 主键选择 34 3.3 列长度的选择 34 3.4列值约定 34 3.5 CREATE脚本 35 3.5 SQL语句 35  概述 我们常常看到很多的编程书籍上都提到了程序的代码规范这个概念，同时也一定听到了很多的程序开发人员告诫那些初学者一定要遵守程序的代码规范。那么到底什么是程序的代码规范呢？我们在编写java程序的过程中又为什么要遵守这些规范呢？ 为什么要制定代码规范 ⑴ 代码规范相当重要。代码规范能够提高软件代码的可读性，使得开发人员快速和彻底的理解新代码。 ⑵ 提高健壮性。好的代码风格不仅会提高可读性，而且会使代码更健壮，更为重要的是在修改时不容易出错。 ⑶ 利于阅读和维护。在现代软件开发中，维护工作会占用80%的时间，而且开发者和维护者通常不是同一个程序员。这意味着你经常要阅读和修改别人开发的程序， 别人也同样可能需要阅读和修改你开发的程序。既然如此，为什么不把这利人利己的事情作好呢？ java编码规范 1. 文件组织 一个文件由被空行分割而成的段落以及标识每个段落的可选注释共同组成。超过2000行的程序难以阅读，应该尽量避免。 1.1 java源文件 每个Java源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共类相关联，可以将它们和公共类放入同一个源文件。公共类必须是这个文件中的第一个类或接口。 Java源文件还遵循以下规则: ??开头注释（参见开头注释） 。 ??包和引入语句（参见包和引入语句） 。 ??类和接口声明（参见类和接口声明） 。 1.2 开头注释 所有的 Java(*.java) 文件都必须遵守如下的样式规则，其中列出类名、版本信息日期和版权声明： / * @(#) someclass.java 创建日期