如何在 Eclipse 中的同一文件中为 2 个单独的类创建 javadoc

Question

我有一个包含 2 个类的短文件，我不想将它们放在单独的文件中。如何为列出这两个类的文件创建 javadoc？现在，当我生成 javadoc 时，它会忽略第二类。 我尝试放入

@see class2Name 

第一堂课的文档注释，但这只是创建了到第二堂课名称的非链接。 如果我的第二个类位于同一个文件中并且不是内部类，正确的方法是什么？ 谢谢

Answer 1

您可以像任何其他类一样对第二个类进行 javadoc，并且应该为这两个类生成文档。如果您正在 Eclipse 中查看 Javadoc 视图，请确保链接到选择（带有 2 个箭头的按钮）并在每个类内部单击以查看其 javadoc，或者只需将鼠标悬停在类名称上。另外，请注意 {@link ExpertImpl}，它允许您链接到第二个类的文档。

简单的例子：

/**
 * This is class one.
 * 
 * {@link ExpertImpl}
 * 
 * @author Me
 * 
 */
public class ClassOne {

}

/**
 * This is class two.
 * 
 * @author Me
 * 
 */
class ExpertImpl {

}

也就是说，这可能是一种个人偏好，但我建议不要将多个类放在同一个文件中。它使您的项目可读性较差，并使事情变得复杂，而没有提供任何真正的好处。您可能想尝试将非公共类放入其自己的文件中，或者将其嵌套在公共类中（如果有意义的话）。希望这有帮助。