良好的注释会让你的代码可读性更强,我拿自己设置的注释模板分享出来。
1.Files为整个Java文件的注释:包括公司名称,版权所属,作者信息,日期等信息项。
/**
* <p>Title: ${file_name}</p>
* <p>Description: </p>
* <p>Copyright: Copyright (c) 2019</p>
* <p>Company: mp.csdn.net</p>
* @author dxy
* @date ${date}
* @version 1.0
*/
2.Types为类注释:
/**
* <p>Title: ${type_name}</p>
* <p>Description: </p>
* @author dxy
* @date ${date}
*/
3.Fields为字段行注释:
/** ${field}*/
4.Constructors为构造方法进行注释:
/**
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/
5.Methods为方法进行注释:
/**
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
*/
6.Overriding Methods为重写方法进行注释:
/* (non-Javadoc)
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/
7.Delegate methods为代表方法进行注释:
/**
* ${tags}
* ${see_to_target}
*/
8.Getters为get方法进行注释:
/**
* @return the ${bare_field_name}
*/
9. Setters为set方法进行注释:
/**
* @param ${param} the ${bare_field_name} to set
*/