首先是注释或阻止注释? (评论风格)

时间:2013-02-12 03:53:24

标签: java annotations comments

/* Prints the coordinate */
@Override
public String toString() {
    return new StringBuilder("(").append(x).append(",").append(y).append(",").append(z).append(")").toString();
}

在上面的示例中,首先是方法的注释。这是通常做的,还是与公认的做法相反?

1 个答案:

答案 0 :(得分:1)

虽然它完全是一个选择问题,或者更确切地说将由团队编码约定决定,但我个人认为遵循一个看起来更好和更具表现力的方式:

/**
  comments
  .... 
*/
@Annotation
type method(){
    ...
    ...
 }