java程序书写规范.docVIP

java程序书写规范 命名规范? ? 1、一般概念? ?? ???1、尽量使用完整的英文描述符? ?? ???2、采用适用于相关领域的术语? ?? ???3、采用大小写混合使名字可读? ?? ???4、尽量少用缩写，但如果用了，必须符合整个工程中的统一定义? ?? ? ? ?? ???5、避免使用长的名字（小于 15 个字母为正常选择）? ?? ???6、避免使用类似的名字，或者仅仅是大小写不同的名字? ?? ???7、避免使用下划线（除静态常量等）? ???2、标识符类型说明? ?? ???1、包（ Package ）的命名? ?? ?? ?? ?Package 的名字应该采用完整的英文描述符，都是由一个小写单词组成。并且包名的前缀总是一个顶级域名，? ?? ?? ?? ?通常是 com、edu、gov、mil、net、org 等；? ?? ?? ?? ?如： com.yjhmily.test? ?? ???2、类（ Class ）的命名? ?? ?? ?? ?类名应该是个一名词，采用大小写混合的方式，每个单词的首字母大写。尽量保证类名简洁而富于描述。? ?? ?? ?? ?使用完整单词，避免缩写词 ( 除非工程内有统一缩写规范或该缩写词被更广泛使用，像 URL ， HTML)? ?? ???如： FileDescription? ?? ???3、接口（ Interface ）的命名? ?? ?? ?? ?基本与 Class 的命名规范类似。在满足 Classd 命名规则的基础之上，保证开头第一个字母为 ”I”，? ?? ?? ?? ?便于与普通的 Class区别开。其实现类名称取接口名的第二个字母到最后，且满足类名的命名规范；? ?? ???如： IMenuEngine? ?? ???4、枚举（ Enum ）的命名? ?? ?? ?? ?基本与 Class 的命名规范类似。在满足 Classd 命名规则的基础之上，保证开头第一个字母为 ”E” ，? ?? ?? ?? ?便于与普通的 Class区别开。? ?? ???如： EUserRole? ?? ???5、异常（ Exception ）的命名? ?? ?? ?? ?异常（ Exception ） 通常采用字母 e 表示异常，对于自定义的异常类，其后缀必须为 Exception? ?? ???如： BusinessException? ?? ???6、方法（ Method ）的命名? ?? ?? ?? ?方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。? ?? ?? ?? ?方法名尽可能的描述出该方法的动作行为。返回类型为 Boolean 值的方法一般由“ is ”或“ has ”来开头? ?? ???如： getCurrentUser() 、 addUser() 、 hasAuthority()? ?? ???7、参数（ Param ）的命名? ?? ?? ?? ?第一个单词的首字母小写，其后单词的首字母大写。参数量名不允许以下划线或美元符号开头，? ?? ?? ?? ?虽然这在语法上是允许的。参数名应简短且富于描述。? ?? ???如： public UserContext getLoginUser(String loginName);? ?? ? ? ?? ???8、常量字段 （ Constants ）的命名? ?? ?? ?? ?静态常量字段（ static final ） 全部采用大写字母，单词之间用下划线分隔；? ?? ???如： public static final Long FEEDBACK;? ?? ???public static Long USER_STATUS; 1.?风格务必保持一贯性(Consistent) 一位同胞顶着我的鼻子问，为什么我们的Java代码缩进格式非得是这样，而不能是他那样，他就是喜欢他自己的这一种，因此他写的代码总是用他自己习惯的风格。结果在Code Review里被大家毙掉，责令修改。因此他是大大地不服。就是风格一贯性问题。其实他的风格，本来也没有什么问题，但在项目里，和其他程序员的程序的风格，显得扃异，那就存在问题了。比如这个缩进，又比如变量命名方法，不同的类，不同的Methods里，各自不同，这程序就很难看了。所以一旦你选择了某种风格，一定要贯彻始终。如果一个项目里规定了一个风格，即便很不符合你自己的习惯，也要贯彻始终，绝不应该有标新立异。 2.?缩进风格(indent) 既然是从缩进说起，就先说说缩进风格;一般来说，象Java这样的类C语言，都采用缩进风格。而常用的，