Что такое API Baseline в Eclipse PDT

Начиная с обновления до Eclipse 3.7, плагин Eclipse PDE хочет, чтобы я задал "базовую линию API" для всех моих проектов Eclipse Plugin.

Однако, похоже, нет документации, которая фактически объясняет, что здесь означает "Базовая линия API" и для чего она используется.

Может кто-нибудь объяснить?

ОТВЕТЫ

Ответ 1

Из Руководство пользователя инструментов API PDE:

Базовая линия API определяет состояние, которое вы хотите сравнить с пакетами рабочих пространств разработки, для целей бинарной совместимости, номеров версий пакетов и тегов @since. Например, если вы разрабатываете пакеты для Eclipse 3.4, вы будете использовать Eclipse 3.3 в качестве базовой линии.

Ответ 3

API Baseline предназначены для поддержки плагинов, которые могут использовать другие пользователи. Инструменты API помогают создавать совместимые версии API. Следуйте по ссылке, которую Sumit Singh опубликовал, чтобы получить объяснение, как их использовать.

Проблема:

  • Вы создаете свой плагин и публикуете версию 1 для публики.
  • Миллионы людей будут использовать ваш плагин и создать свой собственный код, который зависит от API вашего плагина.
  • Вы публикуете версию 2 для публики. По ошибке вы меняете API своего плагина.
  • Миллионы людей обновляют новую версию и должны адаптировать свой код. Тысячи программ терпят неудачу. Люди грустны.

Решение:

  • Вы создаете свой плагин, аннотируете его API и публикуете версию 1 для публики.
  • Миллионы людей будут использовать ваш плагин и создать свой собственный код, который зависит от API вашего плагина.
  • Вы объявляете версию 1 своего плагина API-базой, которая автоматически сравнивается с вашими изменениями кода. Любой перерыв в API представлен вам до того, как вы выпустите свой плагин или запустите свои тесты. Вы выпускаете версию 2 без каких-либо изменений API.
  • Миллионы людей могут обновить ваш плагин в своем приложении, потому что новый выпуск плагина совместим с предыдущим версием.
  • Вы объявляете версию 2 своего плагина....

Резюме

Если вы разрабатываете плагин только для личного использования и не хотите поддерживать совместимый API, вы можете следовать советам, чтобы отключить предупреждения.

Когда вы разрабатываете плагины для сообщества, e. г. сами плагины eclipse, важно, чтобы вы несли совместимость API с минимумом. Затем вы будете следовать рекомендациям и установите базовый уровень в 4.2 при разработке для 4.3. Инструменты API помогут вам сделать 4.3 для всех пользователей 4.2.

Обратите внимание, что API-интерфейсы предназначены для разработчиков плагинов, которые будут использоваться другими. Они не адресованы пользователям этих плагинов.