Eclipse中设置方法注释模板并使用方法注释
设置方法注释模板:选择
eclipse
菜单栏中【窗口】下的【首选项】,展开左边树到
Java->
代码样式
->
代码模板,展开右边出现的对话框中的注释
->
方法,点击右边的【编辑】按钮。编辑其中的内容。也可以点击下面的【插入变量】按钮添加变量。例如:
/**
*
@author${user}
*
功能:
*
${tags}
*/
其中
@author
是
JavaDoc
的标示,带
$
符号的是变量。
使用时鼠标放置在需要添加注释的方法内部的任意位置。点击菜单栏中【源代码】下的【添加
Javadoc
注释】,或者使用快捷键
Alt Shift J
,则
eclipse
自动在该方法前面添加注释,例如
public static void main(String[]args)
生成如下注释:
/**
* @author
hfm
*
功能:
* @param args
*/
当然添加完之后还需要手动添加其中的各项内容,如方法的功能和参数的含义等。 |