Javadoc, связывающий с классом в другом пакете - PullRequest
58 голосов
/ 02 сентября 2011

У меня есть два пакета, Shapes и Fruits:

com.myproject.Shapes.
    Circle
    Square
    Triangle
com.myproject.Fruits.
    Apple
    Orange

Я пишу JavaDoc для Apple и мне нужно предоставить от {@link} до Square.

Я перепробовал все следующие, и ни один из них не работает:

{@link Square}
{@link com.myproject.Square}

Мне удалось найти документацию для ссылки на: (a) классы в том же пакете или (b) внешние URL-адреса, но не классы в другом пакете.

Есть идеи, какой должен быть правильный синтаксис? Спасибо!

Ответы [ 2 ]

79 голосов
/ 02 сентября 2011

Правильный синтаксис варианты:

{@link [<package>.]<class>[#<method>]}
{@link #<method>}

Вы пропустили полный пакет.Следующий пример должен быть правильным

{@link com.myproject.Shapes.Square} 
                     ^^^^^^
17 голосов
/ 26 февраля 2013

Для другого пакета используйте этот синтаксис:

{@link  package.class#member  label}

В вашем случае это должно быть:

{@link com.myproject.Shapes.Square Square}

Если вы хотите показать только имя класса, используйте метку, еслиполный путь требуется, тогда метка не требуется.

Ссылка: http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#link

...