java编码要求规范v1.0.docVIP

JAVA编码规 目 录 TOC \o 1-3 \h \z \u HYPERLINK JAVA编码规 1 HYPERLINK 1 概述 7 HYPERLINK 1.1 围 7 HYPERLINK 1.2 说明 7 HYPERLINK 2 文件体系结构 8 HYPERLINK 2.1 文件体系规则 8 HYPERLINK 规则2.1.1 JSP文件目录结构 8 HYPERLINK 建议2.1.2 Java文件目录结构 8 HYPERLINK 2.2 源文件结构规则 9 HYPERLINK 规则2.2.3 类变量的声明顺序是public,protected,package,private 9 HYPERLINK 规则2.2.4 变量、常量的注释应放在其上方相邻位置 9 HYPERLINK 规则2.2.5 用递增的方式写构造器（比如：参数多的写在后面） 9 HYPERLINK 规则2.2.6 类变量的存取方法：get和set方法 9 HYPERLINK 规则2.2.7 如果定义main() 方法，必须将main方法写在类的底部 9 HYPERLINK 3 文件命名规则 10 HYPERLINK 规则3.1 Structs配置文件命名 10 HYPERLINK 规则3.2 JSP文件命名 10 HYPERLINK 规则3.3 Java文件命名 10 HYPERLINK 4 排版规则 11 HYPERLINK 4.1 语句排版规则 11 HYPERLINK 规则4.2.1简单语句每行至多包含一条语句 11 HYPERLINK 规则4.2.2 复合语句被括其中的语句缩进一个层次 11 HYPERLINK 规则4.2.3 左大括号{应位于复合语句起始行的行尾，前面需加一个空格符；右大括号}应另起一行并与复合语句首行对齐。 11 HYPERLINK 规则4.2.4 必须用{和}将if的语句括起来。(即使只有一条语句的情况下) 11 HYPERLINK 规则4.2.7 在多层嵌套的for语句中，应在for上一行增加逻辑注释 12 HYPERLINK 建议4.2.14 “=”等比较符前后加一个空格 12 HYPERLINK 5 注释规则 13 HYPERLINK 5.1 类注释规则 13 HYPERLINK 规则5.1.1 使用JavaDoc，列出功能、版本信息、日期、作者和声明 13 HYPERLINK 规则5.1.2 如果对文件进行了修改，必须说明修改目的、修改日期、修改人，并变更版本信息 13 HYPERLINK 5.2 类方法注释规则 14 HYPERLINK 规则5.2.1 用中文写出每个参数和返回值的含义 14 HYPERLINK 规则5.2.2 当修改其他组员创建的类时，增加author标签 14 HYPERLINK 5.3 单行注释规则 14 HYPERLINK 规则5.4.1单行注释位于所描述容之前 14 HYPERLINK 规则5.4.2 单行注释之前留一行空行 14 HYPERLINK 5.3.1 接口 14 HYPERLINK 5.3.2 局部变量 14 HYPERLINK 5.3.3 方法 15 HYPERLINK 5.3.4 方法部注释 15 HYPERLINK 6 命名规则 16 HYPERLINK 6.1 包命名规则 16 HYPERLINK 规则6.1.1包的名字全部小写 16 HYPERLINK 6.2 类命名规则 17 HYPERLINK 规则6.2.1类名用英文名称，不用汉语拼音。例如Customer，而不是KH 17 HYPERLINK 规则6.2.2类名是名词，采用大小写混合的方式，每个单词的首字母大写 17 HYPERLINK 规则6.2.3类名不要用复数 17 HYPERLINK 规则6.2.4类名不要以“A”，“An”或“The”开头 17 HYPERLINK 规则6.2.5如果不能选择适当的类名，而该类与数据库一个表紧密相关，再把数据库表名作为类名 17 HYPERLINK 规则6.2.6使用完整单词，避免缩写词(除非该缩写词被更广泛使用，像URL，HTML) 17 HYPERLINK 规则6.2.7 命名方式采用匈牙利式 17 HYPERLINK 6.3 接口命名规则 17 HYPERLINK 规则6.3.1接口的规则与类相同 17 HYPERLINK 规则6.3.2接口名前面加“I” 18 HYPERLINK 6.4 方法命名规则 18 HYPERLINK 规则6.4.