如何在Eclipse中生成Javadoc注释? [重复]

问题描述 投票:193回答:5

可能重复: Javadoc template generator

有没有办法在Eclipse中生成Javadoc注释?如果是这样,它是什么?

java eclipse javadoc
5个回答
341
投票

对我来说,/**<NEWLINE>或Shift-Alt-J(或Mac上的⌘-⌥-J)方法效果最佳。

我不喜欢在源代码中看到Javadoc注释已经自动生成并且没有使用真实内容进行更新。就我而言,这样的javadoc只不过是浪费屏幕空间。

IMO,当您要填写详细信息时,逐个生成Javadoc注释框架会好得多。


78
投票

Shift-Alt-J是Eclipse中用于创建Javadoc注释模板的有用键盘快捷方式。

在类,方法或字段声明上调用快捷方式将创建一个Javadoc模板:

public int doAction(int i) {
    return i;
}

按方法声明中的Shift-Alt-J给出:

/**
 * @param i
 * @return
 */
public int doAction(int i) {
    return i;
}

36
投票

JAutoDoc

一个Eclipse插件,用于自动将Javadoc和文件头添加到源代码中。它可以选择使用Velocity templates为Javadoc和文件头生成元素名称的初始注释...


26
投票

你的意思是菜单Project - > Generate Javadoc?


14
投票

在您想要javadoc的地方,输入/** 它将创建模板。

© www.soinside.com 2019 - 2024. All rights reserved.