先注释或阻止注释？ （评论风格）

Question

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

在上面的示例中，该方法的评论是第一位的。这是通常的做法，还是相反的做法？

Answer 1

虽然它完全选择或者不如说事将通过团队编码conventionn来决定，但我个人觉得以下一个看起来更好的方式和表现：

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