Как создать Javadoc для 2 отдельных классов в одном файле в затмении

Question

У меня есть короткий файл, который состоит из 2 классов, которые я не хочу помещать в отдельные файлы.Как я могу создать Javadoc для файла, который перечисляет оба класса?Прямо сейчас, когда я генерирую Javadoc, он игнорирует второй класс.Я попытался поместить

@see class2Name 

в комментарии к документу для первого класса, но это просто создало отсутствие ссылки на имя второго класса.Каков правильный подход, если мой второй класс находится в том же файле, а не является внутренним классом?Спасибо

Answer 1

Вы можете javadoc второго класса, как и любой другой класс, и документация должна быть сгенерирована для обоих.Если вы смотрите на представление Javadoc в Eclipse, убедитесь, что вы ссылаетесь на выделение (кнопка с 2 стрелками) и щелкаете внутри каждого класса, чтобы увидеть его Javadoc, или просто наводите курсор на имя класса.Также обратите внимание на {@link ExpertImpl}, который позволяет вам ссылаться на документацию второго класса.

Быстрый пример:

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

}

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

}

Тем не менее, это может быть личное предпочтение, но ярекомендовал бы не помещать более одного класса в один файл.Это делает ваш проект менее читабельным и усложняет ситуацию, не предлагая никаких реальных преимуществ.Возможно, вы захотите изучить возможность размещения закрытого класса в своем собственном файле или вложить его в открытый класс, если это имеет смысл.Надеюсь, это поможет.