eclipse 自动为getter和setter添加注释

很苦恼写在 po上的javadoc注释，在其它类中却看不到,只能看到变量名，而这个变量名的中文意义又在这上面的javadoc 中。每次要在Eclipse自动生成的getter,setter 拷贝这些注释或者使用@see ，但是@see 在使用过程提示不直观，还需要再点击进去才能看到详细的javadoc.

网上这样的文章很多：

https://blog.kuoruan.com/42.html

http://m.zgxue.com/158/1582651.html

主要原理即是修改：

org.eclipse.jdt.ui*.jar

org/eclipse/jdt/internal/corext/codemanipulation/GetterSetterUtil.java

打开org.eclipse.jdt.internal.corext.codemanipulation->GetterSetterUtil.java文件，搜索CodeGeneration.getSetterComment和CodeGeneration.getGetterComment，分别在搜索行的下一行添加如下代码：

ISourceRange sr= field.getJavadocRange();
if (null != sr) {
    String filedComment= field.getSource();
    filedComment= filedComment.substring(0, sr.getLength()).replaceAll("[\n,\r,*,/,\t]", "").trim(); //$NON-NLS-1$ //$NON-NLS-2$
    comment= comment.replace("#{bare_field_comment}", filedComment); //$NON-NLS-1$
}

改后的class替换到eclipse工程中的jar包中（可用zip解压、压缩改名），启动Ecipse。

修改Eclipse注释模板

1.Eclipse Window > Preferences > Java > Code Style > Code Templates -> Comments > Getters/Getters
/**
* get #{bare_field_comment} .
* @return ${bare_field_name}
*/
3.设置Setters的Pattern
/**
* set #{bare_field_comment}.
* @param ${param} #{bare_field_comment}
*/

shift+alt+s 生成getter,setter操作时，弹出的框中要勾选Generate method comments，这样就会将属性上的javadoc生成到Getter,setter方法中。

来源：oschina

链接：https://my.oschina.net/u/1261935/blog/542498

标签

笔记