OpenLayers API 설명서 및 개발자 설명서


10

OpenLayers 웹 사이트는 두 가지 참조 문서 세트를 제공합니다.

대부분의 클래스에서 API 문서에는 개발자 문서에 포함 된 작은 하위 집합이 포함되어 있습니다. API 문서에 설명 된 기능만으로는 많은 작업을 수행 할 수 없으므로 개발자 설명서를 사용합니다 (소스 및 예제를 읽습니다).

이 두 문서 세트의 공식적인 차이점은 무엇입니까? API 문서에는 안정적인 인터페이스가 설명되어 있습니까? 개발자 설명서에만 설명 된 기능을 사용하면 나중에 파손될 위험이 있습니까?

답변:


3

조금 수정하려면 응답을 편집해야합니다. OpenLayer와 관련하여 몇 가지 주요 문서가 있습니다.

1- 하나 같은 위키

2- API 문서

3- 개발자 문서

4- 최신 버전 / 트렁크 API 설명서

5- 최신 버전 / 트렁크 개발자 문서

API 설명서는의 안정적인 상세 설명 것입니다 API를 , OpenLayers의 응용 프로그램을 개발할 때 필요한 기타 세부 사항에 대한 개발자 문서 포인트 동안.

"OpenLayers 코드에는 두 가지 유형의 특성 / 방법이 있습니다. 하나는 API 메소드 및 특성 세트입니다. API에 노출되지 않는 추가 내부 특성도 있습니다. Javascript에는 개인 구성원이 없으므로 개인 구성원이 없습니다. 응용 프로그램 코드에서 이러한 문서화되지 않은 메소드 사용에 대한 기술적 제한 사항이지만 릴리스간에 API를 변경하지 않도록 모든 노력을 기울이지 만 API 메소드로 명시 적으로 선언되지 않은 메소드 및 특성은 부 릴리스에서 변경 될 수 있습니다.

위의 "(API 문서 2 및 4)"문서에는 API 메소드 만 포함되어 있습니다. 전체 개발자 / 내부 라이브러리 문서는 "(3 및 5)"아래에서도 사용 가능하지만 위의 API 문서에서 사용할 수없는 메소드는 릴리스간에 동일하게 유지되도록 의존 할 수 없습니다. 이 문서에 포함 된 메소드를 사용하는 경우, OpenLayers의 마이너 릴리스 사이에서 실행되도록 애플리케이션 코드를 수정해야 할 수도 있습니다. "

좋은 답변 : 포인트 2에서 링크 된 최신 릴리스의 API 문서를 사용하여 코드가 새 버전보다 상대적으로 안전해야합니다.

잘못된 답변 <>

내 실제 정답은에 기반 합니다 . 여기에도 비슷한 토론이 있습니다 .

당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.