где находится эта переменная docRoot? - PullRequest
Новая
       12

где находится эта переменная docRoot?

0 голосов
/ 03 сентября 2018

Используя JavaDoc, я пытаюсь добавить уведомление CopyRight в мой исходный код; для этого я добавил следующую строку:

CopyRight см. A href = "{@ docRoot} /C:/Users/ArbolOne/Documents/Dev/Java/CopyRight/JME_LICENSE.html"> Авторские права. **

Это не работает, и при нажатии на ссылку будет отображаться только веб-страница с надписью "Файл не найден".

Тем не менее, это работает, если я изменю строку на:

CopyRight см. A href = "{C: /Users/ArbolOne/Documents/Dev/Java/CopyRight/JME_LICENSE.html"> Авторские права. **

Очевидно, что это нежелательное решение, поэтому мой вопрос, как я могу изменить эту строку так, чтобы {@docRoot} указывал на правильное место? и, кроме того, каково расположение этой переменной docRoot?

Я использую Eclipse / Java 10 на компьютере с Windows. Заранее спасибо за помощь.

1 Ответ

0 голосов
/ 04 сентября 2018

Документация по инструменту Javadoc ясно говорит:

Представляет относительный путь к сгенерированному документу (пункт назначения) корневой каталог с любой сгенерированной страницы.

Здесь важно то, что это относительный путь, который указывает на один и тот же каталог независимо от того, на какой странице вашего Javadoc вы находитесь.

Например, значение {@docRoot} на странице для java/lang/Object будет ../..

Аналогично, на странице для java/util/logging/Logger это будет ../../..

Ваша проблема в том, что вы используете конструкцию, которая задает относительный путь для указания абсолютного пути к JME_LICENSE.html

Было бы проще и практичнее добавить шаг в процессе сборки, чтобы скопировать JME_License.html в корень сгенерированного Javadoc и ссылаться на него как {@docRoot}/JME_LICENSE.html из любого комментария Javadoc.

...