我正在用检查样式检查我的代码。这是这个ide中的垃圾插件。
我不知道为什么我的代码总是显示missing javadoc comment.
就连我也给出了恰当的评论。
请问有没有办法以适当的方式审查代码。
我可以制定自己的规则吗?
更新
每一行都显示缺少的javadoc...在添加注解后
public class MyTest {
/**
* integer Variable I
*/
public static int I = 10;
/**
* String Variable Name
*/
public static String NAME = "XYZ";
/**
* Constructor
*/
public MyTest() {
}
/**
* Main method
* @param args
*/
public static void main(String[] args) {
System.out.print(NAME+"\n"+I);
}
}
2条答案
按热度按时间jaxagkaj1#
您会收到警告,因为缺少javadoc注解:示例
此注解不完整,因为参数未记录在案,但这是检查样式可以接受的最小值(在默认规则中)
同样的做法也适用于类,有时也适用于字段。
您可以启用和禁用特定的检查样式规则,但首先要尝试编写代码,以确保默认规则(太阳检查)不会发出警告。
egdjgwm82#
你也需要一条高于你班级的评论。