Dokumentasi OpenLayers API vs. Dokumentasi Pengembang

Situs web OpenLayers menyediakan dua set dokumentasi referensi:

• API Documents: http://dev.openlayers.org/apidocs/
• Dokumentasi Pengembang: http://dev.openlayers.org/docs/

Untuk sebagian besar kelas, API Documents berisi sebagian kecil dari apa yang ada di Dokumentasi Pengembang. Saya menemukan bahwa saya biasanya tidak dapat menyelesaikan banyak hal hanya dengan menggunakan fitur yang dijelaskan dalam API Documents, jadi saya menggunakan Dokumentasi Pengembang (dan saya membaca sumber dan contohnya).

Apa perbedaan resmi antara dua set dokumentasi ini? Apakah API Documents menjelaskan antarmuka yang diharapkan stabil? Apakah saya mempertaruhkan kerusakan di masa depan jika saya menggunakan fitur yang hanya dijelaskan dalam Dokumentasi Pengembang?

Saya harus mengedit respons saya untuk mengoreksi sedikit. Terkait dengan OpenLayers ada beberapa dokumentasi utama:

1 - Wiki seperti itu

2 - Dokumentasi API

3 - Dokumentasi pengembang

4 - Dokumentasi API versi terakhir / trunk

5 - Versi terakhir / dokumentasi pengembang trunk

Dokumentasi API dimaksudkan menggambarkan detail stabil dari API , sementara dokumentasi Pengembang menunjuk ke detail lain yang diperlukan ketika mengembangkan aplikasi OpenLayers.

"Ada dua jenis properti / metode dalam kode OpenLayers: Satu set adalah set Metode API dan properti. Ada juga properti internal tambahan yang tidak terpapar ke API. Javascript tidak memiliki anggota pribadi, jadi tidak ada keterbatasan teknis untuk menggunakan metode yang tidak didokumentasikan dalam kode Aplikasi. Namun, sementara kami berupaya untuk tidak mengubah API antara rilis, metode, dan properti yang tidak secara eksplisit dinyatakan sebagai Metode API dapat berubah dalam rilis kecil.

Dokumentasi di atas "(API doc 2 dan 4)" hanya mencakup Metode API. Dokumentasi pengembang / perpustakaan lengkap lengkap juga tersedia di bawah "(3 dan 5)", tetapi metode yang tidak tersedia dalam dokumentasi API di atas tidak dapat diandalkan untuk tetap sama di antara rilis. Jika Anda menggunakan metode yang termasuk dalam dokumen ini, Anda mungkin harus membuat modifikasi dalam kode aplikasi Anda untuk berjalan di antara rilis minor OpenLayers. "

JAWABAN BAIK: Anda harus mengandalkan dokumen API dari rilis terbaru, tautan dari titik 2, untuk memastikan kode Anda relatif aman dibandingkan versi baru.

JAWABAN SALAH <>

Respons saya yang sebenarnya sebenarnya didasarkan pada . Ada diskusi serupa di sini .