Documentación de la API de OpenLayers vs. Documentación del desarrollador


10

El sitio web de OpenLayers proporciona dos conjuntos de documentación de referencia:

Para la mayoría de las clases, los documentos de API contienen un pequeño subconjunto de lo que se encuentra en la documentación del desarrollador. Creo que, por lo general, no puedo hacer mucho con las funciones descritas en los documentos de API, por lo que utilizo la documentación del desarrollador (y leo la fuente y los ejemplos).

¿Cuál es la distinción oficial entre estos dos conjuntos de documentación? ¿Los documentos de API describen interfaces que se espera que sean estables? ¿Me arriesgo a una ruptura futura si uso las funciones descritas solo en la Documentación del desarrollador?

Respuestas:


3

Debo editar mi respuesta para corregir un poco. Relacionado con OpenLayers hay varias documentaciones principales:

1 - Un wiki como uno

2 - documentación de la API

3 - Documentación del desarrollador

4 - Última versión / documentación de la API troncal

5 - Última versión / documentación del desarrollador del tronco

La documentación de la API pretende describir los detalles estables de la API , mientras que la documentación de los desarrolladores apunta a otros detalles que son necesarios al desarrollar aplicaciones OpenLayers.

"Hay dos tipos de propiedades / métodos en el código de OpenLayers: un conjunto es el conjunto de métodos y propiedades de la API. También hay propiedades internas adicionales que no están expuestas a la API. Javascript no tiene miembros privados, por lo que no hay limitación técnica para usar estos métodos no documentados en el código de la Aplicación. Sin embargo, si bien hacemos todo lo posible para no cambiar las API entre versiones, los métodos y propiedades que no se declaran explícitamente como Métodos API pueden cambiar en versiones menores.

La documentación anterior "(API doc 2 y 4)" solo incluye los Métodos API. La documentación completa de la biblioteca interna / del desarrollador también está disponible debajo de "(3 y 5)", pero no se puede depender de los métodos que no están disponibles en la documentación API anterior para que permanezcan igual entre versiones. Si utiliza los métodos incluidos en estos documentos, es posible que deba realizar modificaciones en el código de su aplicación para ejecutar entre versiones menores de OpenLayers ".

BUENA RESPUESTA: debe confiar en los documentos API de la última versión, enlace desde el punto 2, para asegurarse de que su código sea relativamente seguro con respecto a las nuevas versiones.

RESPUESTA INCORRECTA <>

Mi respuesta correcta real se basa en . Hay una discusión similar aquí .

Al usar nuestro sitio, usted reconoce que ha leído y comprende nuestra Política de Cookies y Política de Privacidad.
Licensed under cc by-sa 3.0 with attribution required.