提出问题

项目中的代码如何注释才合格？？？
简书地址：http://www.jianshu.com/users/d38a3668be58/latest_articles

解决问题

下面是来自《代码整洁之道》中自己的一些简单总结：

1)观念：整洁清楚的代码比注释要好得多，代码即注释，真正好的注释就是考虑不用写注释,注释就是一种失败；

2)删掉被注释掉的代码；

3)TODO注释，提示尚未完成的工作；

4)真正需要注释的地方：

提供法律信息
具有警示性的注释；
描述一些业务场景；
有些函数现在还是一个空壳，但在将来可能有用，有必要写

5)避免括号后面的注释；

package com.hwy.test;
/**
 * 代码整洁之道
 * Created by Ay on 2016/7/11.
 */
public class CodeCleanTest {
    public static void main(String[] args) {
        /** 这段代码是不需要注释的,看方法名称就可以清楚知道意图了 **/
        engagements();
        boolean isMerryMe =  canMerryMe();
        if(isMerryMe){//避免括号后面的注释，例如这
            getMarried();
            /** 删掉被注释掉的代码； **/
            //String ring = "";
        }
        /** TODO注释，提示尚未完成的工作 **/
        //TODO 结婚生子
        /** 悄悄话内容,这里涉及到一些业务上的事，所以需要注释下 **/
        String whisperContent =  getwhisperContent();
    }
    /**
     * 获得悄悄话内容
     * @return
     */
    public static String getwhisperContent(){
        return "XXX OOO";
    }
    public static void engagements(){
        System.out.println("约会");
    }
    public static boolean canMerryMe(){
        boolean isLoveMe = true;
        if(isLoveMe)return true;
        return false;
    }
    public static void getMarried(){
        System.out.println("结婚");
    }
}