OpenLayers API文档与开发人员文档


10

OpenLayers网站提供了两组参考文档:

对于大多数类,API文档仅包含开发人员文档中的一小部分。我发现通常仅使用API​​文档中描述的功能并不能完成很多工作,因此我使用了开发人员文档(并且阅读了源代码和示例)。

这两个文档集之间的正式区别是什么?API文档是否描述了预期稳定的接口?如果我使用仅在开发人员文档中描述的功能,是否有将来遭受破坏的风险?

Answers:


3

我必须编辑我的回答以更正一点。与OpenLayers有关,有几个主要文档:

1- 像一个维基

2- API文档

3- 开发人员文档

4- 最新版本/ trunk API文档

5- 最新版本/ trunk开发者文档

API文档的目的是描述的细节稳定API,而开发者文档点开发的OpenLayers应用程序时所需要的其他细节。

“ OpenLayers代码中有两种类型的属性/方法:一组是API方法和属性的集合。还有一些其他内部属性未公开给API。Javascript没有私有成员,因此没有私有成员。在应用程序代码中使用这些未记录方法的技术限制,但是,尽管我们竭尽全力在版本之间不更改API,但未明确声明为API的方法和属性可能会在次要版本中更改。

“(API文档2和4)”上方的文档仅包含API方法。完整的开发人员/内部库文档也可在“(3和5)”下面找到,但以上API文档中未提供的方法不能依赖于两个版本之间保持不变。如果您使用这些文档中包含的方法,则可能必须对应用程序代码进行修改才能在次要版本的OpenLayers之间运行。”

很好的答案:您应该依赖最新版本的API文档(从第2点开始的链接),以确保您的代码相对于新版本而言相对安全。

错误答案<>

我实际的正确的反应是基于。有一个类似的讨论在这里

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.