Tài liệu API OpenLayers so với Tài liệu dành cho nhà phát triển


10

Trang web OpenLayers cung cấp hai bộ tài liệu tham khảo:

Đối với hầu hết các lớp, Tài liệu API chứa một tập hợp con nhỏ của Tài liệu dành cho nhà phát triển. Tôi thấy rằng tôi thường không thể hoàn thành nhiều việc chỉ bằng các tính năng được mô tả trong Tài liệu API, vì vậy tôi sử dụng Tài liệu dành cho nhà phát triển (và tôi đã đọc nguồn và ví dụ).

Sự khác biệt chính thức giữa hai bộ tài liệu này là gì? API Docs có mô tả các giao diện được dự kiến ​​là ổn định không? Tôi có nguy cơ bị phá vỡ trong tương lai nếu tôi sử dụng các tính năng chỉ được mô tả trong Tài liệu dành cho nhà phát triển không?

Câu trả lời:


3

Tôi phải chỉnh sửa câu trả lời của mình để sửa lại một chút. Liên quan đến OpenLayers có một số tài liệu chính:

1 - Một wiki như một

2 - Tài liệu API

3 - Tài liệu dành cho nhà phát triển

4 - Tài liệu API phiên bản / thân cuối

5 - Tài liệu dành cho nhà phát triển phiên bản / thân cuối

Tài liệu API được dự định mô tả các chi tiết ổn định của API , trong khi tài liệu dành cho Nhà phát triển chỉ ra các chi tiết khác cần thiết khi phát triển ứng dụng OpenLayers.

"Có hai loại thuộc tính / phương thức trong mã OpenLayers: Một bộ là tập hợp các Phương thức và thuộc tính API. Ngoài ra còn có các thuộc tính nội bộ bổ sung không được hiển thị với API. Javascript không có thành viên riêng tư, vì vậy không có Tuy nhiên, trong khi chúng tôi nỗ lực không thay đổi API giữa các bản phát hành, phương thức và thuộc tính không được khai báo rõ ràng là Phương thức API có thể thay đổi trong bản phát hành nhỏ.

Tài liệu ở trên "(API doc 2 và 4)" chỉ bao gồm các Phương thức API. Tài liệu thư viện nội bộ / nhà phát triển đầy đủ cũng có sẵn bên dưới "(3 và 5)", nhưng các phương thức không có sẵn trong tài liệu API ở trên không thể phụ thuộc vào việc giữ nguyên giữa các bản phát hành. Nếu bạn sử dụng các phương thức có trong các tài liệu này, bạn có thể phải sửa đổi trong mã ứng dụng của mình để chạy giữa các bản phát hành nhỏ của OpenLayers. "

TRẢ LỜI TỐT: Bạn nên dựa vào tài liệu API của phiên bản mới nhất, liên kết từ điểm 2, để đảm bảo mã của bạn tương đối an toàn so với các phiên bản mới.

SAU TRẢ LỜI <>

Phản ứng chính xác thực tế của tôi là dựa trên . Có một cuộc thảo luận tương tự ở đây .

Khi sử dụng trang web của chúng tôi, bạn xác nhận rằng bạn đã đọc và hiểu Chính sách cookieChính sách bảo mật của chúng tôi.
Licensed under cc by-sa 3.0 with attribution required.