Шаблон:Javadoc:SE

Java SE 19 API Javadocs

Документация шаблона [ просмотр ] [ правка ] [ история ] [ очистка ]

Шаблон для создания внешней ссылки в Javadoc для класса в текущей версии Java SE API. Этот шаблон следует использовать вместо явного URL, чтобы разрешить автоматическое обновление ссылки до последней версии API при обновлении этого шаблона.

Пожалуйста, обновите Template:Javadoc:SE/Home_URL , чтобы обновить версию Java, на которую эта ссылка перенаправляет пользователей.

Использование

Вот распространенные формы использования этого шаблона:

В приведенном выше примере clone()может быть любым членом, задокументированным в Javadoc , который не является классом или интерфейсом, поэтому производит . Для члена класса или интерфейса имя класса — , поэтому производит .{{Javadoc:SE|java/lang|System|out}}System.outOuterClass.InnerClass{{Javadoc:SE|java/lang|Character.Subset}}Character.Subset

URL-адреса Javadoc не включают общие параметризованные типы. Чтобы отобразить параметры типа, укажите параметр classи/или memberв шаблоне, чтобы переопределить имя отображаемого класса и/или имя члена. Обратите внимание, что нотация параметризованного типа использует угловые скобки ( <и >), поэтому имена параметров типа, соответствующие тегам разметки HTML, должны использовать кодировки символов < для <и >для >.

URL метода использует полное имя пути типов параметров. Параметр memberможет использоваться для использования простого имени типа параметров метода, как показано в предыдущей таблице, или даже для полного исключения параметров.

Наконец, если ни один из вышеперечисленных способов не подходит для отображаемого текста, предоставление nameпараметра позволяет заменить все отображаемое имя пакета/класса/члена. (Однако параметр nameне переопределит текст, отображаемый при использовании формы.){{Javadoc:SE}}

Проблемы

1. Некоторые версии Javadoc, например, версия, используемая для создания текущих страниц API Javadoc, вставляют пробелы между именами параметров в тегах привязки, используемых для ссылок на определения членов. К сожалению, это означает, что для получения ссылки на метод или конструктор с двумя или более параметрами для корректного отображения сигнатура метода/конструктора требует как отображаемой, так и ссылочной версии, например:

Ссылки в текущей версии не содержат пробелов, пробелы просто удалены в тегах анкоров.

1. Включение квадратных скобок ([, ]) в типы параметров аргументов метода или члена конструктора, похоже, нарушает шаблон. Вместо этого замените квадратные скобки их числовыми кодами экранирования ссылок на символы, [ и ], например:

1. Все, что не находится в модуле java.base API Java, должно объявить moduleпараметр, чтобы гарантировать, что пользователь будет отправлен в правильную область документации. Если moduleне указано, шаблон будет по умолчанию java.base- который, если рассматриваемый элемент не находится в java.base, отправит читателя на страницу 404.

Смотрите также

• Шаблон:Javadoc:SE
• Шаблон:Javadoc:SE-guide
• Шаблон:Javadoc:EE
• Шаблон:Javadoc:Android
• Шаблон:Javadoc:SE/Home_URL

Вышеуказанная документация включена из Template:Javadoc:SE/doc . ( edit | history ) Редакторы могут экспериментировать на страницах sandbox (create | mirror) и testcases (create) этого шаблона . Добавьте категории на подстраницу /doc . Подстраницы этого шаблона .