OpenLayers APIドキュメントと開発者ドキュメント


10

OpenLayers Webサイトでは、2組のリファレンスドキュメントを提供しています。

ほとんどのクラスの場合、APIドキュメントには、開発者ドキュメントにあるものの小さなサブセットが含まれています。私は通常、APIドキュメントに記載されている機能だけを使用しても多くのことを成し遂げることができないので、開発者用ドキュメントを使用します(ソースと例を読みます)。

これら2つのドキュメントセットの公式の違いは何ですか?APIドキュメントは、安定していると予想されるインターフェースを記述していますか?開発者向けドキュメントにのみ記載されている機能を使用すると、将来的に破損する危険がありますか?

回答:


3

回答を少し修正する必要があります。OpenLayersに関連して、いくつかの主要なドキュメントがあります。

1 - 1のようなウィキ

2- APIドキュメント

3- 開発者向けドキュメント

4- 最終バージョン/トランクAPIドキュメント

5- 最終バージョン/トランク開発者向けドキュメント

APIドキュメントは、APIの安定した詳細を説明することを目的としていますが、開発者向けドキュメントは、OpenLayersアプリケーションを開発するときに必要なその他の詳細を示しています。

"OpenLayersコードには2種類のプロパティ/メソッドがあります。1つのセットはAPIメソッドとプロパティのセットです。APIに公開されていない追加の内部プロパティもあります。JavaScriptにはプライベートメンバーがないため、ドキュメントに記載されていないこれらのメソッドをアプリケーションコードで使用する場合の技術的な制限。

上記の「(API doc 2および4)」のドキュメントには、APIメソッドのみが含まれています。完全な開発者/内部ライブラリのドキュメントも「(3および5)」の下にありますが、上記のAPIドキュメントで利用できないメソッドは、リリース間で同じであるとは限りません。これらのドキュメントに含まれるメソッドを使用する場合、OpenLayersのマイナーリリース間で実行するために、アプリケーションコードを変更する必要がある場合があります。 "

良い答え:コードが新しいバージョンに比べて比較的安全であることを確認するには、ポイント2からのリンクである最新リリースのAPIドキュメントに依存する必要があります。

間違った回答<>

私の実際の正しい回答はに基づいています。ここでも同様の議論があります

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.