javadoc @docRoot

Question

Может ли кто-нибудь показать мне пример этого тега javadoc?

Я не очень хорошо понимаю, как использовать его в коде

Answer 1

javadoc documentation имеет пару хороших примеров. Он всегда указывает на корень документации, поэтому, если на каждой странице есть что-то, что вы хотите включить, вы используете его для поиска корня javadoc, поскольку относительный путь будет отличаться от страницы к странице.

Например, для включает в себя логотип вашей компании в верхней части каждой сгенерированной страницы документации, вы можете поместить logo.png в корне документации, а затем добавить:

<img src="{@docRoot}/logo.png"> 

к JavaDoc заголовку

Answer 2

это несколько ниже кода

@author //this will give name of author 

@see  //it is used to point to refrence 

@since //this will give from which version it is included 

@link // this is used to provide link to another file 

пример: HTTP: //www.docjar.net/html/api/java/util/Collections.java.html

документ стандарт: HTTP: //www.oracle.com/technetwork/java/ javase/documentation/index-137868.html # тег