Documentação da API OpenLayers vs. Documentação do desenvolvedor


10

O site do OpenLayers fornece dois conjuntos de documentação de referência:

Para a maioria das classes, os Documentos da API contêm um pequeno subconjunto do que está na documentação do desenvolvedor. Acho que geralmente não consigo fazer muito usando apenas os recursos descritos nos Documentos da API, então uso a documentação do desenvolvedor (e leio a fonte e os exemplos).

Qual é a distinção oficial entre esses dois conjuntos de documentação? Os Documentos da API descrevem interfaces que se espera sejam estáveis? Estou arriscando quebras futuras se usar os recursos descritos apenas na documentação do desenvolvedor?

Respostas:


3

Preciso editar minha resposta para corrigir um pouco. Relacionado ao OpenLayers, existem várias documentações principais:

1 - Um wiki como um

2 - documentação da API

3 - Documentação do desenvolvedor

4 - Documentação da última versão / API do tronco

5 - Documentação do desenvolvedor da última versão / tronco

A documentação da API visa descrever os detalhes estáveis ​​da API , enquanto a documentação dos Desenvolvedores aponta para outros detalhes necessários ao desenvolver aplicativos OpenLayers.

"Existem dois tipos de propriedades / métodos no código do OpenLayers: Um conjunto é o conjunto de métodos e propriedades da API. Também há propriedades internas adicionais que não são expostas à API. O Javascript não possui membros particulares, portanto, não há limitação técnica ao uso desses métodos não documentados no código do aplicativo.No entanto, enquanto nos esforçamos para não alterar APIs entre releases, métodos e propriedades que não são explicitamente declarados como API Methods podem ser alterados em releases menores.

A documentação acima "(os documentos 2 e 4 da API)" inclui apenas os métodos da API. A documentação completa do desenvolvedor / biblioteca interna também está disponível abaixo de "(3 e 5)", mas não é possível confiar nos métodos que não estão disponíveis na documentação da API acima para permanecer o mesmo entre as liberações. Se você usar os métodos incluídos nesses documentos, talvez seja necessário fazer modificações no código do aplicativo para executar entre versões menores do OpenLayers. "

BOA RESPOSTA: Você deve confiar nos documentos da API da versão mais recente, link do ponto 2, para garantir que seu código seja relativamente seguro nas novas versões.

RESPOSTA ERRADA <>

Minha resposta correta real é baseado em . Há uma discussão semelhante aqui .

Ao utilizar nosso site, você reconhece que leu e compreendeu nossa Política de Cookies e nossa Política de Privacidade.
Licensed under cc by-sa 3.0 with attribution required.