一、alt+shift+j的使用方法
原文地址:https://www.cnblogs.com/xuedexin/articles/5658346.html
1.鼠标点击空白处(光标 在class的上方),使用alt+shift+j 快捷键产生作者的名字。(Types注释模板)
2.鼠标点击方法名,使用alt+shift+j 快捷键产生方法的注释。稍微修改下,方便写注释。(Methods注释模板)
这样写出的注释,可以被eclipse轻松的生成api文档,这对别人了解你的项目是十分有帮助的。
————————————
Eclipse如何生成文档(javadoc):
在项目列表中按右键,选择Export(导出),然后在Export(导出)对话框中选择java下的javadoc,提交到下一步。 在Javadoc Generation对话框中有两个地方要注意的: javadoc command:应该选择jdk的bin/javadoc.exe destination:为生成文档的保存路径,可自由选择。 按finish(完成)提交即可开始生成文档。
__________________________________________________________________________________________
在eclipse中,alt+shift+j,在keys配置中的名字叫add javadoc comment,
在菜单中是source->generate element comment
二、Eclipse中修改各种注释模板(alt+shift+j)
原文地址:http://blog.csdn.net/i_lovefish/article/details/25979703
设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍:
文件(Files)注释标签:
/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}(用一句话描述该文件做什么)
* @author A18ccms A18ccms_gmail_com
* @date ${date} ${time}
* @version V1.0
*/
类型(Types)注释标签(类的注释):
/**
* @ClassName: ${type_name}
* @Description: ${todo}(这里用一句话描述这个类的作用)
* @author A18ccms a18ccms_gmail_com
* @date ${date} ${time}
*
* ${tags}
*/
字段(Fields)注释标签:
/**
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
*/
构造函数标签:
/**
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/
方法(Constructor & Methods)标签:
/**
* @Title: ${enclosing_method}
* @Description: ${todo}(这里用一句话描述这个方法的作用)
* @param ${tags} 设定参数(一个或多个,自动)
* @return ${return_type} 返回类型
* @throws
*/
覆盖方法(Overriding Methods)标签:
/* (非 Javadoc)
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/
代表方法(Delegate Methods)标签:
/**
* ${tags}
* ${see_to_target}
*/
getter方法标签:
/**
* @return ${bare_field_name}
*/
setter方法标签:
/**
* @param ${param} 要设置的 ${bare_field_name}
*/