Как помешать Javadoc использовать полное имя?
Я использую инструмент 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 я исправил это, перейдя в представление "Проект", а затем переключившись в представление "Файлы". Затем в файлах проекта найдите nbproject/project.properties
и откройте этот файл (щелкните правой кнопкой мыши, выберите открыть).
В окне свойств прокрутите вниз слева, пока не увидите javadoc.additionalparam
, Затем добавьте следующее в правую часть этого свойства (в моем случае его значение было пустым) -link https://docs.oracle.com/en/java/javase/11/docs/api/
Затем сохраните (control-S) файл и соберите. Javadocs теперь выглядят так, как я хотел. Спасибо, Слав!
1 ответ
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>
вариант.
Примечание: я полагаю, что оба варианта предоставляются "Стандартным доклетом".Если стандартный доклет не используется, эти параметры могут быть недоступны или работать по-другому.