Javadoc Variable
【原因分析】
java类中的成员变量没有写Javadoc注释。例如下面这个java类中的name变量:
public class Person {
private String name;
}
【影响分析】
不完整的注释将会给代码的维护带来更大的难度,使java代码的可读性下降。
【修改建议】
在日常开发的时候养成良好的编码习惯,注释尽可能写得详细和完整。例如:
public class Person {
/**
* 姓名
*/
private String name;
}