设置注释模板的步骤:点击菜单栏上的Window -->Preferences-->Java-->Code Style -->Code Templates,对右侧Comments选项中具体的注释信息进行编辑即可。可勾选上自动添加注释信息,在生成java文件时便会自动生成注释,当然也可以手动插入注释。设置的界面如下:
选中需要修改的注释模版(例如图中,Overriding methods),点击Edit按钮,进入编辑页面,编辑完成后,点击OK按钮。
全部编辑完成后点击“Apply And Close”即可设置完成,并关闭设置页面。
以下是具体Comment设置
1. Files为整个Java文件的注释:包括公司名称,版权所属,作者信息,日期等信息项。
/**
* <p>Title: ${file_name}</p>
扫描二维码关注公众号,回复: 5615761 查看本文章* <p>Description: </p>
* <p>Copyright: Copyright (c) 2019</p>
* <p>Company: mp.csdn.net</p>
* @author jph
* @date ${date}
* @version 1.0
*/
2. Types为类注释:
/**
* <p>Title: ${type_name}</p>
* <p>Description: </p>
* @author jph
* @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
*/