2015-12-16 2 views
2

Я только начал с разработки плагинов для Eclipse, но всякий раз, когда я создаю один из примеров проектов, JavaDoc не используется для методов, которые используются в сгенерированном коде.Как получить JavaDoc для разработки плагинов Eclipse?

Я использую пример HelloWorld и там есть, например, этот сгенерированный код:

public void run(IAction action) { 
    MessageDialog.openInformation(
    window.getShell(), 
    "Miau", 
    "Hello, Eclipse world"); 
} 

Однако метод openInformation() не имеет какого-либо JavaDoc не прилагается ни делает MeesageDialog или любой другой класс/метод/интерфейс, используемый в созданном примере.

Есть ли способ добавить JavaDoc к этим методам/классам/etc?

ответ

2

Доступен ли JavaDoc в зависимости от того, как вы настроили свой target platform. Исходные пакеты или Функции источника необходимы для того, чтобы IDE предоставила JavaDoc.

Кроме того, источники позволяют отлаживать шаг через код платформы, заглядывать в источник, если документация недостаточно ясна и т. Д. Следовательно, вы, вероятно, всегда захотите иметь источники.

Если вы добавляете компоненты на целевую платформу с сайта программного обеспечения, убедитесь, что опция Включить источник, если есть опция.

При выборе компонентов, предпочитают SDK функции или также включают Ресурс. Например, укажите Платформа Eclipse Platform SDK вместо Платформа Eclipse, так как она содержит исходный код и документацию. Если ваша цель требует инструментов разработки Java Eclipse, обязательно включите в нее ресурсы разработчика Eclipse JDT Plug-in, а в последнем - документацию и исходный код.

Add Content Dialog

+0

Hm ... У меня есть полный JDT (с ресурсами) и полный Eclipse SDK, но у меня все еще нет JavaDoc для классов, созданных мастером плагинов ... В моем «нормальном» Java-коде я есть JavaDoc ... Может быть, потому что я все еще использую Eclipse 4.4? – Raven

+0

Нет, не имеет ничего общего с Eclipse 4.4. Что вы подразумеваете под _installed_? –

+0

Eclipse сообщает мне, что эти вещи загружаются и устанавливаются, когда я пытаюсь перейти к справке> Установить новое программное обеспечение, а затем выбрать эти сущности. – Raven

0

Я думал, что это место было настроено на сайт Java по умолчанию для работы, когда в Интернете. Если вы хотите иметь документацию в автономном режиме, сделайте следующее:

Сначала загрузите и извлеките javadocs для установленной версии JRE.

От Eclipse go Windows -> Настройки -> Развернуть Java -> Установленные JREs -> Выберите JRE, для которого вы хотите документы, -> Нажмите «Изменить» -> Выбрать все системные библиотеки -> Выберите местоположение JavaDoc и выберите место, где вы извлекли документы.

* EDIT - Просто заметил, что метод, на который вы смотрите, не находится в ядре Java. Если вы хотите добавить Java Docs или Source в ссылочную библиотеку, разверните ссылки, затем щелкните правой кнопкой мыши нужную банку и выберите предпочтения, оттуда вы сможете добавить документы или источник, которые вы должны загрузить.

+0

Моя проблема не в том, что у меня вообще нет JavaDoc ... Для нормального использования Java это работает просто отлично ... Только когда я начинаю что-то делать с плагинами и соответствующими классами, я получаю заметку, что JavaDoc не привязан к этому классу ... – Raven

Смежные вопросы