java编程规范-注释

 

注释

 

对于方法内部用throw语句抛出的异常，必须在方法的注释中标明，对于所调用的其他方法所抛出的异常，选择主要的在注释中说明。对于非RuntimeException，即throws子句声明会抛出的异常，必须在方法的注释中标明。(1.42+)

说明：异常注释用@exception或@throws表示，在JavaDoc中两者等价，但推荐用@exception标注Runtime异常，@throws标注非Runtime异常。异常的注释必须说明该异常的含义及什么条件下抛出该异常。

 避免在注释中使用缩写，特别是不常用缩写。(1.42+)

说明：在使用缩写时或之前，应对缩写进行必要的说明。

 

对重载父类的方法必须进行@Override声明(5.0+)

说明：可清楚说明此方法是重载父类的方法，保证重载父类的方法时不会因为单词写错而造成错误(写错方法名或者参数个数，类型都会编译无法通过)

示例：

    @Override

    public void doRequest(SipServletRequest req) throws ServletException,

           IOException