软件开发文档 Java API最佳实践(2)

7、熟悉api接口开发，这里包括你自行开发api的能力以及调用第三方api的经验，功能文档，流程图，时序图。

在java的开发过程中，难免会遇到一些疑问，jdk api 1.6chm参考文档为这些问题做了详细的讲解和api分析，此java api 中文文档是java 2 platform standard edition 6.0 的 api 规范，相信能够帮助大家更好的掌握技巧。

2.2 文档完备

既然是提供给他人使用，那么完备的文档很重要。接下来会介绍如何编写高质量、详尽的 JavaDoc 文档。

2.3 一致性

呈现例子，分类归纳例子展示、操练、表征观点（提取的概念属性）工具选择例子，确定呈现方式，收集概念属性例子分类，归纳概念属性。

价格的三个一致性原则：产品系列内部价格一致：如所有47克价格一致产品类别内部价格一致：与竞争对手同类品种价格之比保持一致商店内部产品类别价格一致：如与雀巢产品价格之比保持一致。

因为大量自然现象具有连续性,所以拓扑学具有广泛联系各种实际事物的可能性.通过拓扑学的研究,可以阐明空间的集合结构,从而掌握空间之间的函数关系.本世纪三十年代以后,数学家对拓扑学的研究更加深入,提出了许多全新的概念.比如,一致性结构概念、抽象距概念和近似空间概念等等.有一门数学分支叫做微分几何,是用微分工具来研究取线、曲面等在一点附近的弯曲情况,而拓扑学是研究曲面的全局联系的情况,因此,这两门学科应该存在某种本质的联系.1945 年,美籍中国数学家陈省身建立了代数拓扑和微分几何的联系,并推进了整体几何学的发展.。

为了解释什么是 sdk 我们不得不引入 api、动态链接库、导入库等等概念。

可以用 getXYZ() 或者 xyz()，但不要两种同时出现。

如果有两个函数（其中一个函数重载了另一个函数。比如一个函数用 Object... 作为参数，另一个用 Collection），那么尽可能在所有的地方都进行重载。

重点是建立一套团队中公用的词汇表和“备忘清单”，并在整个 SDK 中通过这种方式保证一致性。

2.4 适用性

在开发 API 的过程中，必须确保 API 为目标用户提供合适的抽象级别。可以从两方面考虑：

只做一件事，并且把它做好。

理解使用 API 的人，以及他们的目标。

cpu缓存（cache memory）位于cpu与内存之间的临时存储器,它的容量比内存小但交换速度快.在缓存中的数据是内存中的一小部分,但这一小部分是短时间内cpu即将访问的,当cpu调用大量数据时,就可避开内存直接从缓存中调用,从而加快读取速度.由此可见,在cpu中加入缓存是一种高效的解决方案,这样整个内存储器（缓存+内存）就变成了既有缓存的高速度,又有内存的大容量的存储系统了.缓存对cpu的性能影响很大,主要是因为cpu的数据交换顺序和cpu与缓存间的带宽引起的.。

bql查询同步支持缓存查询，只需要调用bmobquery的setcachepolicy方法设置缓存策略即可，建议使用如下方式进行bql缓存查询：。

解释一下标红的部分，先建立一个byte数组obj，将data缓存数据存储进obj数组，callstaticvoidmethod是c调用java函数，最后执行实在camera.java(框架）的posteventfromnative（）。

要请求垃圾收集，可以调用下面的方法：gc.collection()一般不需要手动调用gc.collection()。

2.5 约束

开发新 API 的过程可能非常快。但我们应该在心里提醒自己，每个新的 API 都有可能承诺终身支持。

新的项目我们想用asp.net core来开发，但是苦于我们历史的遗产很多，比如《》，我们要估计等到.net core 1.2我们才会有大部分的api，通过nodejs方式有点曲线救国的味道，很会不认同，如果要在纯的.net core下运行我们的asp.net core项目，在特定的时间进度内很难办到，不仅仅我们所依赖的一些api还没有，还有我们大量的.net framwork的库还来不及迁移到.net standard 兼容。

并且子问题之间满足最优化定理：假设为了解决某一优化问题，需要依次作出n个决策d1，d2，…，dn，如若这个决策序列是最优的，对于任何一个整数k，1< k

本文来自电脑杂谈，转载请注明本文网址：
http://www.pc-fly.com/a/jisuanjixue/article-92212-2.html