Java 中的注释

Java 中的注释

关于// TODO

“// TODO Auto-generated method stub”

是我们写类或继承接口自动生成的提示，可以留也可以不用，不过可以提示阅读者这段代码是自动生成的

根据下面途径找到Method body

• window
  • Preferences
    • Java
      • Code Style
        • Code Templates
          • Code
            • Method Body

选择edit或者双击文本区进行编辑，删去默认的内容即可

关于@Override 的作用

可以说@Override是伪代码，可以表示重写父类的方法，删去也可以，不过我们可以用来当作提示。

• 提示该方法是父类所拥有的，如果你在一个父类没有的方法上写了@Override，编译器一般会报错。

• 如果前面没有@Override，并且方法名是父类中没有的，编译器会认为这个方法是子类中自己增加的方法。

可以参考下面的代码：

//这是一个接口
public interface Framework{
    void frameMain();       //用于设置主窗口
    void frameInitial();    //用于初始化各个部件
    void frameAction();     //用于向各个部件添加事件
    void frameLocate();     //用于定位各个部件在窗口的位置
    void frameAdd();        //用于将各个部件添加到主窗口
    void toExit();          //用于一个释放该窗口资源的方法
}

/**
* @Author: PQ  
* @Data: 2018年8月24日
*/
public class Test implements Framework{
    
    public Test(){
        frameMain();
        frameInitial();
        frameAction();
        frameLocate();
        frameAdd();
        
        this.setVisible(true);  //显示窗口
    }

    @Override
    public void frameMain() {
        // TODO Auto-generated method stub
        
    }

    @Override
    public void frameInitial() {
        // TODO Auto-generated method stub
        
    }

    @Override
    public void frameAction() {
        // TODO Auto-generated method stub
        
    }

    @Override
    public void frameLocate() {
        // TODO Auto-generated method stub
        
    }

    @Override
    public void frameAdd() {
        // TODO Auto-generated method stub
        
    }

    @Override
    public void toExit() {
        // TODO Auto-generated method stub
        
    }

}

注释问题

“别给糟糕的代码加注释-重新写吧”

什么也比不上放置良好的注释来的有用
什么也不会比乱七八糟的注释更有本事搞乱一个模块。
什么也不会比陈旧、提供错误信息的注释更有破坏性。

1. 注释不能美化糟糕的代码

写注释的常见动机之一是糟糕的代码的存在。

2. 用代码来阐述

有时候只需要创建一个描述与注释所言同一事物的函数就行

3. 好注释

• 法律信息
• 提供信息的注释
• 对意图的解释
• 阐释

注释把某些晦涩难明的参数或返回值的意义翻译为某种可读形式是有用的，但是尽量让参数或者返回值自身足够清楚就足够了

• 警示

//Don't look at me code！！！

• TODO 注释

有时可以用TODO注释来标注我们这个函数将要用来做什么，通常用来表示程序员认为应该做，但由于某些原因目前还没做的工作

• 放大

可以用来放大某种看来不合理的的代码

坏注释

通常坏注释都是糟糕代码的支撑或借口，对错误决策的修正，

总结：大多时候有意义的命名比注释更友好。