什么样的注释才是好注释？

在代码中加入注释是很重要的，那么，什么样的注释才是规范的呢？每一句statement后面都加上一句注释？
每一个方法前面都加上一段注释？
在每一个类的开都用大段注释说明？怎样的注释格式是最清晰易于阅读的呢？请各位高手指教啊！

解决方案 »

  1.   

    不要为了注释而注释,  如果代码逻辑很清晰,命名很规范, 那么可以少用注释;
    如果是为别人要调用的API,那么每个类和每个public方法和字段都要注释,以方便生成API文档
      

  2.   

    记得以前看过一个叫java coding style的东西，那上面专门有一节讲注释的！个人认为讲的很好！我记得以前的那个是pdf的，刚从网上找了个chm的。
    http://download.csdn.net/source/1190316
      

  3.   

    非常感谢啊，我去找了一下，貌似找到了pdf的那个。不知道是不是
    http://wenku.baidu.com/view/06512368a98271fe910ef959.html