在Eclipse中使用@Javadoc视图有什么用处

Question

我在日食中注意到了@javadoc视图。你能否告诉我这是什么用途以及如何使用它。

Answer 1

您展示的视图是Eclipse @ Javadoc视图。 Javadoc视图显示在Java编辑器或Java视图中选择的元素的Javadoc。

要使用它，只需在Java视图中打开包含Javadoc的Java文件（或使用Java透视图）。完成后， Javadoc视图将自动填充。

Answer 2

Eclipse确实提供了用于创建自己的JavaDoc的合适工具，这是一个好主意，因为那些必须使用您的代码的人将能够看到它的作用。

• 有一个键盘快捷键可以为类或方法添加一个块（在Mac上它是Command-Shift-J我认为，但是在键映射中搜索Javadoc。

• 您可以定义模板以添加链接等非常重要的内容，以便快速创建JavaDoc

• 当你在Eclipse中编写文档时，它足够智能指向现有的文档，所以说你创建一个接口，你在接口中记录方法，然后在每个实现者中，如果你在接口之后创建它们，你会得到一个块，指向你回到界面

当你添加自己的或者团队中的其他人时，这个视图让你看到它会是什么样子，所以它有双重目的：让你更容易阅读别人的JavaDoc的标记，以及预览你自己的。