如何在Eclipse中的方法中添加注释块?

时间:2011-09-11 14:14:11

标签: java eclipse javadoc

是否可以轻松地向Eclipse项目中的每个方法添加注释块(Javadoc样式)以及可能的类,以便稍后填写它们?

7 个答案:

答案 0 :(得分:32)

根据建议你可以按方法进行方法(来源 - >生成元素评论)或ALT+SHIFT+J,但我发现这是一个非常糟糕的主意。注释仅在提供其他信息时才有用。当您感觉需要更多信息时,请添加它。

对像“设置值”这样的设置者发表评论或更糟糕的是自动生成评论它根本没用。

答案 1 :(得分:8)

  

窗口|偏好| Java |代码风格|代码模板

你会发现2个功能:

  • 自动为新方法或类型添加注释
  • 评论|方法|编辑...

您可以使用eclipse变量或静态Javadoc文本编辑生成的注释块。

答案 2 :(得分:5)

要为方法 选择getUser 添加注释,请在getUser 之前执行游标,然后按ALT + SHIFT + J它会在方法上添加注释

/*
* @param
* @return User
*/
public User getUser();

答案 3 :(得分:2)

也许你正在寻找这个

http://jautodoc.sourceforge.net/

答案 4 :(得分:2)

简单的一点是,你只需输入/ **然后在方法的顶部按 Enter ,你想要生成注释。它会自动生成元素注释。不需要长按键输入

答案 5 :(得分:0)

使用以下步骤,您将轻松完成。 在eclipse中转到Project - >生成javadoc - >按Enter键,然后选择要记录的项目。

答案 6 :(得分:0)

Mac用户: ^ - - J

  • 选项 - ⌥
  • 控制 - ^

Windows用户: Shift - Alt - J

PS:确保您安装了JAutodoc插件