Как помешать Javadoc использовать полное имя? - PullRequest
Новая
       98

Как помешать Javadoc использовать полное имя?

0 голосов
/ 29 января 2019

Я использую инструмент Javadoc для документирования некоторого кода, а в результатах используются полные имена для системных классов, такие как java.lang.String.Есть ли способ остановить это специально для классов в иерархии java.* и javax.*?

Например, определение метода, подобное этому: 

    * @param field String to write.
    * @throws IOException If the underlying stream throws an exception.
    */
   public void writeField( String field ) throws IOException {
      // etc.

Создает вывод Javadoc, как это: 

writeField

public void writeField​(java.lang.String field) throws java.io.IOException

    ...etc.

Parameters:
    field - String to write.
Throws:
    java.io.IOException - If the underlying stream throws an exception.

Я бы хотел, чтобы ссылка на java.lang.String была просто String, а ссылка на java.io.IOException аналогично была бы IOException.

Любые идеи?

Редактировать и обновлять повторно.принятый ответ ниже:

В NetBeans 10 я исправил это, перейдя в представление Project, а затем переключился в представление Files.Затем в файлах проекта найдите nbproject/project.properties и откройте этот файл (щелкните правой кнопкой мыши, выберите «Открыть»).

В представлении свойств прокрутите вниз слева, пока не увидите javadoc.additionalparam.Затем добавьте следующее в правую часть этого свойства (в моем случае его значение было пустым) -link https://docs.oracle.com/en/java/javase/11/docs/api/

Затем сохраните (control-S) файл и соберите.Javadocs теперь выглядят так, как я хотелСпасибо, Слав!

1 Ответ

0 голосов
/ 29 января 2019

Javadoc выводит полное имя, если оно не может ссылаться на класс / метод / и т. Д.Чтобы вывести простое имя, нужно связать его с внешним Javadoc.Это делается с помощью параметра командной строки -link <url> инструмента javadoc.Для связи с классами SE (т. Е. java.* и javax.*) можно использовать один из вариантов: 

javadoc -link https://docs.oracle.com/en/java/javase/11/docs/api/ [...]

Где [...] - остальная часть командной строки.Вы можете изменить URL-адрес, чтобы он указывал на другую версию Java (например, Java 8 вместо Java 11).

Существует также опция -linkoffline <url1> <url2>.

Примечание.оба варианта предоставляются «Стандартным доклетом».Если стандартный доклет не используется, эти параметры могут быть недоступны или работать по-другому.

...