Документация OpenLayers API против Документация разработчика

10

Веб-сайт OpenLayers предоставляет два набора справочной документации:

Для большинства классов Документы API содержат небольшое подмножество того, что находится в Документации разработчика. Я нахожу, что обычно я не могу многого добиться, используя только функции, описанные в Документах API, поэтому я использую Документацию разработчика (и читаю исходный код и примеры).

Каково официальное различие между этими двумя комплектами документации? Описывают ли Документы API интерфейсы, которые должны быть стабильными? Не рискую ли я в будущем, если буду использовать функции, описанные только в документации для разработчиков?

Кристофер Джонсон
источник

Ответы:

3

Я должен отредактировать свой ответ, чтобы исправить немного. Относительно OpenLayers существует несколько основных документов:

1 - Вики как один

2 - API документация

3 - Документация для разработчиков

4 - Последняя версия / документация по транковым API

5 - Последняя версия / транк Документация для разработчиков

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

«Существует два типа свойств / методов в коде OpenLayers: один набор представляет собой набор методов и свойств API. Существуют также дополнительные внутренние свойства, которые не предоставляются API. Javascript не имеет закрытых членов, поэтому нет техническое ограничение на использование этих недокументированных методов в коде приложения. Однако, хотя мы прилагаем все усилия, чтобы не менять API-интерфейсы между выпусками, методы и свойства, которые явно не объявлены как методы API, могут изменяться в небольших версиях.

Приведенная выше документация "(API doc 2 и 4)" включает только методы API. Полная документация для разработчика / внутренней библиотеки также доступна ниже "(3 и 5)", но методы, которые недоступны в документации API выше, не могут зависеть от того, чтобы они оставались неизменными между выпусками. Если вы используете методы, включенные в эти документы, вам, возможно, придется вносить изменения в код приложения, чтобы он запускался между второстепенными выпусками OpenLayers. "

ХОРОШИЙ ОТВЕТ: Вы должны полагаться на документы API последней версии (ссылка из пункта 2), чтобы убедиться, что ваш код относительно безопасен по сравнению с новыми версиями.

НЕПРАВИЛЬНЫЙ ОТВЕТ <>

Мой фактический правильный ответ основан на . Существует аналогичное обсуждение здесь .

Никулита Михай
источник