JAVA命名规范培训.doc

Java命名规范培训 修改记录 目 录 1.命名 Camel大小写 标识符的首字母小写，而每个后面连接的单词的首字母都大写。 例如：backColor 这是在Java编码中默认的方式。 大写 标识符中的所有字母都大写。主要针对常量的定义。 例如： public static final int MAX_VALUE = 100; 小写 标识符中的所有字母都小写。这个主要是针对包的命名。 例如： com.woyo.was.xxx; 区分大小写 为了避免混淆和保证跨语言交互操作，请遵循有关区分大小写的使用的下列规则： 1、不要使用要求区分大小写的名称。 对于区分大小写和不区分大小写的语言，组件都必须完全可以使用。不区分大小写的语言无法区分同一上下文中仅大小写不同的两个名称。因此，在创建的组件或类中必须避免这种情况。 2、不要创建仅是名称大小写有区别的两个命名空间。 例如，不区分大小写的语言无法区分以下两个命名空间声明。 namespace ee.cummings; namespace Ee.Cummings; 3、不要创建具有仅是大小写有区别的参数名称的函数。 下面的示例是不正确的。 void myFunction(String a, String A) 4、不要创建具有仅是大小写有区别的方法名称的类型。 在下面的示例中，calculate 和 Calculate 是不适当的方法名称，原因是它们仅是大小写有区别。 void calculate() void Calculate() 缩写 为了避免混淆和保证跨语言交互操作，请遵循有关区缩写的使用的下列规则： 1、不要将缩写或缩略形式用作标识符名称的组成部分。 例如，使用 getWindow，而不要使用 getWin。 2、不要使用计算机领域中未被普遍接受的缩写。 3、在适当的时候，使用众所周知的缩写替换冗长的词组名称。 例如，用 UI 作为 User Interface 的缩写，用 OLAP 作为 On-line Analytical Processing 的缩写。 措词 禁止使用和Java关键字冲突的标识符。 命名包名 命名包名时的一般性规则是公司性质.公司名称.产品名称.功能细分；全部小写； 例如： com.woyo.wos.xxx; com.woyo.was.xxx; 工具函数类包名缀为.util 类包名为. 　 test case类包名为.test 类包名为. service类包名为. 以下规则概述命名类的指南： Class 的名字采用Camel大小写，如： DataSet.java 对于实现Business Fa?ade的Session Bean，应当命名为类名+Controller 对于类的命名为：类名+作用,如：类名+”Factory”, 类名+”Helper”, 类名+”Delegate”, 类名+”Adapter” 对于接口的实现，应当命名为：接口名+Impl 对于实现事件的类，应当命名为：类名+”Event” 对于实现监听器的类，应当命名为：类名+”Listener” 对于实现异常的类，应当命名为：类名+”Exception” 文件命名： 文件的命名采用组合英文单词，每个单词首字母大写，或采用取英文单词首字母大写。文件扩展名一律小写。 Java文件扩展名为.java Jsp文件扩展名为.jsp Javascirpt文件扩展名为.js。与JSP文件对应的Javascirpt文件，要求采用相同的文件名。 CSS文件扩展名为.css。与JSP文件对应的CSS文件，要求采用相同的文件名。 Html文件扩展名为.html Image文件扩展名为.gif，jpg,png,jpeg Resource文件后缀为.properties，.xml 参数命名指南 以下规则概述参数的命名指南： 1、使用描述性参数名称。 参数名称应当具有足够的描述性，以便参数的名称及其类型可用于在大多数情况下确定它的含义。 2、对参数名称使用 Camel 大小写。 3、使用描述参数的含义的名称，而不要使用描述参数的类型的名称。 开发工具将提供有关参数的类型的有意义的信息。因此，通过描述意义，可以更好地使用参数的名称。少用基于类型的参数名称，仅在适合使用它们的地方使用它们。 4、不要使用保留的参数。 保留的参数是专用参数，如果需要，可以在未来的版本中公开它们。相反，如果在类库的未来版本中需要更多的数据，请为方法添加新的重载。 5、不要给参数名称加匈牙利语类型表示法的前缀。 以下是正确命名的参数的示例。 Type getType(string typeName) String format(string format, object[] args) 方法