Главная » Java » {©docRoot

0

 

 Файлы,  генерируемые приложением  javadoc, размещаются в древовидной

туре каталогов, каждый из которых содержит какую-то часть документации.

Точное положение файлов в структуре каталогов определяется конкретной

реализацией javadoc и может быть изменено в зависимости от настроек рабочей

среды и предпочтений пользователя. Вполне возможно добавить в ранее постро-

е дерево дополнительные  элементы,  а затем ссылаться  на них  из  текста

комментариев документирования.

  Встраиваемый тэг {@docROOt} позволяет помещать в текст комментариев относительные ссылки на другие файлы, расположенные в дереве каталогов документов. При создании документации тэг {@docROOt} заменяется строкой, содержащей описание пути к корневому каталогу дерева документов. Например, поместив в комментарий строку

лицензионное соглашение вы найдете

  <а href="{@docRoot}/license.html">здесь</а>.

вы получите предложение, содержащее гиперссылку на файл license.html, который размещен в корневом каталоге дерева документов. После создания документации следует скопировать файл по указанному адресу, и ссылка окажется работоспособной. В некоторых случаях, однако, удобнее применять механизм, описанный в разделе 14.4.2

 

Источник: Арнолд, Кен, Гослинг, Джеймс, Холмс, Дэвид. Язык программирования Java. 3-е изд .. : Пер. с англ. – М. : Издательский дом «Вильяме», 2001. – 624 с. : ил. – Парал. тит. англ.

По теме:

  • Комментарии