Документація API OpenLayers порівняно з Документацією для розробників

Веб-сайт OpenLayers пропонує два набори довідкової документації:

• Документи API: http://dev.openlayers.org/apidocs/
• Документація для розробників: http://dev.openlayers.org/docs/

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

У чому полягає офіційна відмінність цих двох комплектів документації? Чи описують документи Документів API інтерфейси, які, як очікується, будуть стабільними? Чи ризикую я в майбутньому поломкою, якщо використовую функції, описані лише в Документації для розробників?

Я повинен відредагувати свою відповідь, щоб трохи виправити. Що стосується OpenLayers, існує декілька основних документацій:

1 - Вікі, як одна

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

3 - Документація розробника

4 - Остання документація щодо останньої версії / магістралі

5 - Остання версія / документація розробника

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

"У коді OpenLayers є два типи властивостей / методів. Один набір - це набір методів та властивостей API. Також існують додаткові внутрішні властивості, які не піддаються API. У JavaScript немає приватних членів, тому немає технічне обмеження на використання цих бездокументованих методів у коді програми, однак, хоча ми докладаємо всіх зусиль, щоб не змінювати API між випусками, методи та властивості, які не є чітко заявленими як методи API, можуть змінюватися в незначних випусках.

Документація вище "(API док. 2 та 4)" включає лише Методи API. Повна документація для розробників / внутрішньої бібліотеки також доступна нижче "(3 та 5)", але методи, недоступні в документації API вище, не можуть залежати, щоб вони залишалися однаковими між випусками. Якщо ви використовуєте методи, включені в ці документи, можливо, вам доведеться внести зміни в код програми, щоб переходити між незначними випусками OpenLayers. "

ДОБРИЙ ВІДПОВІДЬ: Вам слід покластися на документи API останньої версії, посилання з пункту 2, щоб переконатися, що ваш код відносно безпечний щодо нових версій.

НЕВІДОМНА ВІДПОВІДЬ <>

Моя фактична правильна відповідь заснована на . Існує аналогічне обговорення тут .