เอกสารประกอบ OpenLayers API กับเอกสารสำหรับนักพัฒนา


10

เว็บไซต์ OpenLayers มีเอกสารอ้างอิงสองชุด:

สำหรับคลาสส่วนใหญ่เอกสาร API มีชุดย่อยขนาดเล็กของสิ่งที่อยู่ในเอกสารสำหรับนักพัฒนา ฉันพบว่าฉันมักจะไม่สามารถทำได้มากนักโดยใช้เพียงคุณสมบัติที่อธิบายไว้ในเอกสาร API ดังนั้นฉันจึงใช้เอกสารสำหรับนักพัฒนา (และฉันอ่านแหล่งที่มาและตัวอย่าง)

อะไรคือความแตกต่างอย่างเป็นทางการระหว่างเอกสารทั้งสองชุดนี้? เอกสาร API อธิบายถึงอินเทอร์เฟซที่คาดว่าจะเสถียรหรือไม่? ฉันจะเสี่ยงต่อการแตกหักในอนาคตหรือไม่หากฉันใช้คุณสมบัติที่อธิบายไว้ในเอกสารสำหรับนักพัฒนาเท่านั้น

คำตอบ:


3

ฉันต้องแก้ไขคำตอบของฉันเพื่อแก้ไขเล็กน้อย ที่เกี่ยวข้องกับ OpenLayers มีเอกสารหลักหลายประการ:

1 - วิกิเหมือนกับหนึ่ง

2 - เอกสาร API

3 - เอกสารสำหรับนักพัฒนา

4 - เอกสาร API รุ่นล่าสุด / trunk

5 - เอกสารประกอบล่าสุดสำหรับนักพัฒนา trunk /

เอกสาร API มีวัตถุประสงค์เพื่ออธิบายรายละเอียดที่มั่นคงของAPIในขณะที่เอกสารประกอบของนักพัฒนาซอฟต์แวร์ชี้ไปที่รายละเอียดอื่น ๆ ซึ่งจำเป็นสำหรับการพัฒนาแอพพลิเคชั่น OpenLayers

"คุณสมบัติ / วิธีมีสองประเภทในรหัส OpenLayers: หนึ่งชุดคือชุดของวิธีการและคุณสมบัติของ API นอกจากนี้ยังมีคุณสมบัติภายในเพิ่มเติมที่ไม่ได้สัมผัสกับ API Javascript ไม่มีสมาชิกส่วนตัวดังนั้นจึงไม่มี ข้อ จำกัด ทางเทคนิคในการใช้วิธีการที่ไม่ใช่เอกสารเหล่านี้ในรหัสแอปพลิเคชันอย่างไรก็ตามในขณะที่เราพยายามทุกวิถีทางที่จะไม่เปลี่ยนแปลง APIs ระหว่างการเผยแพร่วิธีการและคุณสมบัติที่ไม่ได้ประกาศอย่างชัดเจนว่าเป็นวิธีการ API อาจเปลี่ยนแปลง

เอกสารด้านบน "(API เอกสาร 2 และ 4)" มีเฉพาะวิธีการ API เอกสารสำหรับนักพัฒนา / ห้องสมุดภายในฉบับเต็มยังมีให้บริการด้านล่าง "(3 และ 5)" แต่วิธีการที่ไม่สามารถใช้ได้ในเอกสาร API ข้างต้นไม่สามารถขึ้นอยู่กับการใช้งานเหมือนเดิมระหว่างการเผยแพร่ หากคุณใช้วิธีการที่รวมอยู่ในเอกสารเหล่านี้คุณอาจต้องทำการแก้ไขในรหัสแอปพลิเคชันของคุณเพื่อให้ทำงานระหว่าง OpenLayers รุ่นย่อย "

คำตอบที่ดี: คุณควรพึ่งพาเอกสาร API ของรุ่นล่าสุดลิงก์จากจุด 2 เพื่อให้แน่ใจว่ารหัสของคุณปลอดภัยเทียบกับเวอร์ชันใหม่

ตอบผิด <>

ตอบที่ถูกต้องของฉันที่เกิดขึ้นจริงจะขึ้นอยู่กับ มีการอภิปรายที่คล้ายกันคือที่นี่

โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.