Java 重写接口函数时是否自动生成注释?
我想要这样的东西Java 重写接口函数时是否自动生成注释?,java,interface,Java,Interface,我想要这样的东西 public interface A { void doSth(int a); // a in ms } 当我覆盖doSth时,注释“a in ms”也会出现在代码中 A a = new A() { @Override public void doSth(int a) { // a in ms ... } }; 只需使用JavaDoc,更加清晰易读 public interface A { /** * Wr
public interface A {
void doSth(int a); // a in ms
}
当我覆盖doSth时,注释“a in ms”也会出现在代码中
A a = new A() {
@Override
public void doSth(int a) { // a in ms
...
}
};
只需使用
JavaDoc
,更加清晰易读
public interface A {
/**
* Write your method java doc
* @param a The int must be in milliseconds
*/
void doSth(int a);
}
我还建议您使用清晰的参数名称:例如,您可以将
int a
替换为int毫秒
在eclipse中,有一个名为Auto generate comments的选项,它将在创建新类或接口时生成注释存根
您必须自己在接口中编写javadoc注释,如下所示:
public interface IThing {
/**
* This method does something with milliseconds
* @param millis the milliseconds for the calculation
*/
void doSomething(int millis);
}
然后,当您创建一个实现接口的类时,重写的方法在其javadoc注释中获得一个引用,使它们在接口中显示该方法的注释:
public class Thing implements IThing {
/* (non-Javadoc)
* @see mypackage.IThing#doSomething(int)
*/
@Override
public void doSomething(int millis) {
System.out.println("The calculation got the value of "
+ millis + " milliseconds as parameter");
}
}
语法类似于javadoc标记{package}.{interface}{method(参数类型}
,这里:
@请参阅mypackage.IThing#doSomething(int)
我不知道您是否正在使用eclipse,但似乎您也可以在其他IDE中使用这些引用(我认为这是一个javadoc特性)。
试试看,也许这就是你想要的
或者,您可能想看看
为什么不直接说:void doSth(int timeInMS);?只需将注释放在接口的方法上(
/**…*/
style),当您将鼠标悬停在覆盖方法上时,它将出现在您的IDE中。此接口位于aar库中,因此当我使用它时,参数将被重命名。此接口位于aar库中,因此当我使用它时,参数将被重命名。我编写java文档,但注释仍不会出现在IDE中。我使用android studio,它似乎没有这样的功能选项。然后您可能必须自己将非javadoc继承放在子类的方法中。我目前没有Android Studio,无法查看选项。如果您手动编写javadoc继承,javadoc继承是否有效?我的接口被其他开发人员使用,因此我希望我的注释在覆盖函数时以某种方式出现。如果您是编写接口并对其进行注释,然后其他开发人员必须使用我的一个建议…如果您编写正确的javadoc注释,当他们重写方法并应用某种javadoc继承时,它就会出现。只需告诉他们如何操作即可。