OpenLayers API Belgeleri ve Geliştirici Belgeleri


10

OpenLayers web sitesi iki referans belgesi seti sağlar:

Çoğu sınıf için, API Dokümanları Geliştirici Dokümantasyonundaki öğelerin küçük bir alt kümesini içerir. Genellikle sadece API Dokümanlarında açıklanan özellikleri kullanarak fazla bir şey yapamadığımı görüyorum, bu yüzden Geliştirici Dokümanlarını kullanıyorum (ve kaynak ve örnekleri okuyorum).

Bu iki belge kümesi arasındaki resmi ayrım nedir? API Dokümanları, kararlı olması beklenen arayüzleri açıklıyor mu? Yalnızca Geliştirici Belgeleri'nde açıklanan özellikleri kullanırsam gelecekteki kırılma riskiyle mi karşılaşıyorum?

Yanıtlar:


3

Biraz düzeltmek için cevabımı düzenlemeliyim. OpenLayers ile ilgili birkaç ana belge var:

1 - Bir wiki benzeri

2 - API belgeleri

3 - Geliştirici belgeleri

4 - Son sürüm / ana hat API belgeleri

5 - Son sürüm / trunk Geliştirici belgeleri

API belgeleri kararlı ayrıntılarını açıklamak amaçlanmıştır API , OpenLayers uygulamaları geliştirmek gerektiğinde diğer ayrıntılar Geliştiriciler belgeleri noktası ise.

"OpenLayers kodunda iki tür özellik / yöntem vardır: Bir küme API Yöntemleri ve özellikleri kümesidir. API'ye maruz kalmayan ek iç özellikler de vardır. Javascript'in özel üyeleri yoktur, bu nedenle Bu, belgelenmemiş yöntemlerin Uygulama kodunda kullanılmasına ilişkin teknik sınırlama Ancak, API'ları sürümler arasında değiştirmemek için her türlü çabayı gösterirken, API Yöntemleri olarak açıkça bildirilmeyen yöntemler ve özellikler küçük sürümlerde değişebilir.

Yukarıdaki belgeler ((API doc 2 ve 4) "yalnızca API Yöntemlerini içerir. Tam geliştirici / dahili kütüphane belgeleri aşağıda "(3 ve 5)" de mevcuttur, ancak yukarıdaki API belgelerinde bulunmayan yöntemler, sürümler arasında aynı kalması için kullanılamaz. Bu dokümanlarda bulunan yöntemleri kullanırsanız, küçük OpenLayers sürümleri arasında çalıştırmak için uygulama kodunuzda değişiklikler yapmanız gerekebilir. "

İYİ CEVAP: Kodunuzun yeni sürümler üzerinde görece güvenli olduğundan emin olmak için 2. sürümden gelen bağlantıların en son sürümünün API belgelerine güvenmelisiniz.

YANLIŞ CEVAP <>

Benim asıl Doğru yanıt dayanır üzerinde . Burada da benzer bir tartışma var .

Sitemizi kullandığınızda şunları okuyup anladığınızı kabul etmiş olursunuz: Çerez Politikası ve Gizlilik Politikası.
Licensed under cc by-sa 3.0 with attribution required.