10 votos

Documentación de la API de OpenLayers vs Documentación del Desarrollador

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

Para la mayoría de las clases, la API Docs contener un subconjunto pequeño de lo que es en la Documentación para Desarrolladores. Me parece que por lo general no puede conseguir mucho más por hacer uso solo de las características descritas en la API de google Docs, por lo que utilizar la Documentación para Desarrolladores (y he leído la fuente y ejemplos).

¿Qué es el oficial de la distinción entre estos dos conjuntos de documentación? Hacer la API Docs describir las interfaces que se espera que sea estable? Estoy arriesgando el futuro de la rotura si puedo utilizar las funciones descritas sólo en la Documentación para Desarrolladores?

3voto

Niculita Mihai Puntos 582

Tengo que editar mi respuesta para corregir un poco. Relacionados con OpenLayers existen varios documentación:

1 - Un wiki como una

2 - la documentación de la API

3 - documentación del Desarrollador

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

5 - la Última versión/tronco documentación del Desarrollador

La documentación de la API es la intención de describir el establo detalles de la API, mientras que la documentación de los Desarrolladores de punto a otros detalles que son necesarios cuando el desarrollo de OpenLayers aplicaciones.

"Hay dos tipos de propiedades/métodos en la OpenLayers código: Uno es el conjunto de Métodos de la API y propiedades. También hay espacio adicional en el interior de las propiedades que no están expuestos a la API. Javascript no tiene miembros privados, por lo que no hay ninguna limitación técnica para el uso de estos métodos documentados en el código de la Aplicación. Sin embargo, aunque hacemos todo lo posible por no cambiar de Api entre versiones, métodos y propiedades que no son explícitamente declarado como Métodos de la API puede cambiar en versiones menores.

La documentación de arriba "(la API doc 2 y 4)" sólo incluye los Métodos de la API. Completa desarrollador/interno de la documentación de la biblioteca también está disponible abajo "(3 y 5)", pero los métodos que no están disponibles en la documentación de la API de arriba no puede ser dependido de la misma estancia, entre versiones. Si utiliza los métodos incluidos en estos documentos, usted puede tener que hacer modificaciones en el código de la aplicación para que se ejecute entre versiones menores de OpenLayers."

BUENA RESPUESTA : Usted debe confiar en la API docs de la última publicación, enlace del punto 2, para asegurarse de que su código es relativo seguro en las nuevas versiones.

RESPUESTA INCORRECTA <>

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

i-Ciencias.com

I-Ciencias es una comunidad de estudiantes y amantes de la ciencia en la que puedes resolver tus problemas y dudas.
Puedes consultar las preguntas de otros usuarios, hacer tus propias preguntas o resolver las de los demás.

Powered by:

X