8

   

、常量字段 （

Constants ）的命名

            

 

静态常量字段（

static final   

） 全部采用大写字母，单词之间用下划

线分隔；
        

 

如：

public static final Long FEEDBACK;

        public static Long USER_STATUS;

 

三、注释规范

        一个很好的可遵循的有关注释的经验法则是：

            

问问你自己，你如果从未见过这段代码，要在合理的时间内有效地明白这段代码，

你需要一些什么信息？？？

 

       

 1、一般概念

            1、注释应该增加代码的清晰度

            2、保持注释的简洁

            3、在写代码之前或同时写注释

            4、注释出为什么做了一些事，而不仅仅是做了什么

        

2、注释哪些部分

            1、Java 文件：必须写明版权信息以及该文件的创建时间和作者；

            2、类：类的目的、即类所完成的功能，以及该类创建的时间和作者名称
多人一次编辑或修改同一个类时，
                应在作者名称处出现多人的名称；

            3

 

、接口： 在满足类注释的基础之上，接口注释应该包含设置接口的目

的、它应如何被使用以及如何不被使用。
                在接口注释清楚的前提下对应的实现类可以不加注释；

            4

 

 

、方法注释： 对于设置

(Set 

 

方法

) 

 

与获取

(Get 

 

方法

) 成员的方法，

在成员变量已有说明的情况下，
                可以不加注释；普通成员方法要求说明完成什么功能，参数含义是
什么且返回值什么；另外方法的创建
                时间必须注释清楚，为将来的维护和阅读提供宝贵线索；

            5

 

、方法内部注释： 控制结构，代码做了些什么以及为什么这样做，处

理顺序等，特别是复杂的逻辑处理部分，