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

Question

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

@see class2Name 

在第一个类的doc注释中，但它只是创建了一个非第二个类名称的链接。 如果我的第二个类在同一个文件中，并且不是内部类，那么正确的方法是什么？ 感谢

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 {

}

也就是说，这可能是个人偏好，但我建议不要在同一个文件中放置多个类。它使您的项目可读性降低，并使事情变得复杂，而不会带来任何实际好处。您可能想要探索将非公共类放在自己的文件中，或者将其嵌入公共类中，如果有意义的话。希望这会有所帮助。