api帮助文档怎么用（api文档）

今天给各位分享api帮助文档怎么用的知识，其中也会对api文档进行解释，如果能碰巧解决你现在面临的问题，别忘了关注本站，现在开始吧！

本文目录一览：

• 1、怎么使用java的帮助文档API？谢谢
• 2、java怎么使用API帮助文档？
• 3、如何使用jdk1.6的API帮助文档
• 4、API是什么意思？API文档又是什么意思？
• 5、如何使用 Core Plot 的 API 帮助文档

怎么使用java的帮助文档API？谢谢

JAVA的在线文档：

此文档分为3个版块，左上为包，左下为包中的类、接口等，右侧即为选定的类或者接口的说明。

比如：首先选择一个包：java.io

再选择类中的File，此时右侧出现了类File的相关信息，如：摘要字段、构造方法、方法摘要等。可以从中选择您需要的类编写出想要达到的功能。

希望对您有帮助。祝好！

java怎么使用API帮助文档？

API就像学汉字时候的汉语字典一样，编程的时候需要用到的基本类都在API里面存在了，并且随着时间的推移，这些类的数量会越来越多。

一般打开API，你可以看到三部分，左上，左下和右边。左上部分是所有的包，它是最大的部分；然后左下部分是你所选的左上部分的包里面的具体内容，一般有接口、类、枚举、异常、错误等等。当你选择左下部分的具体类的时候，在右部分就会出现这个类的具体解释，然后是它的构造方法，常用方法等。我们主要关注的是常用方法。

看API的时候，比如你要找String类，那么你首先需要知道它在类的什么位置，也就是在哪个包里面，然后你通过连接找到String类（在java.lang包里面），然后在java.lang包里面找到String类，接着就可以查看String类的具体内容了。比如在解释String的时候，就说了String对象是不可改变的，（这听起来似乎比其他的废话重要一点），然后是对String类的方法做了一个大概的介绍。接着，就可以看具体的方法了。

比如说，你要比较一个字符串，那么就需要用到equals(Object anObject)方法，它的参数是一个对象，方法解释是：将此字符串与指定的对象比较。

具体用法，比如String str = "a"; str.equals("b");

因为“a"不等于"b"，所以，这个方法返回的是false。

如何使用jdk1.6的API帮助文档

没有帮助文档的朋友可以在有联网的电脑上自行下载ps：jdk1.6版有中文版的）···

打开帮助文档···

先熟悉下他的界面，大体上分4快···

现在可以按 ctrl+f 调出 查找

输入你想查询的功能，发现有关信息会帮你检索到···

点击相关包，就可以看到相应的接口了，是不是比自己去看来的方便啊····

API是什么意思？API文档又是什么意思？

API（Application Programming Interface,应用程序编程接口）是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。

API文档是一个技术内容交付文件，包含如何有效地使用和集成api的说明。它是一个简明的参考手册，包含了使用API所需的所有信息，详细介绍了函数、类、返回类型、参数等，并有教程是示例支撑。

API文档传统上是使用常规内容创建和维护工具和文本编辑器完成的。API描述格式如OpenAPI /Swagger规范具有自动文档编制流程，它使得团队更容易生成和维护API文档。

采用模式在技术领域已经开始向开发者转移。拥有良好的API文档的一个重要原因是它提高了使用API的开发者体验，它与API的采纳有直接的关系。

API函数包含在位于系统目录下的DLL文件中。你可以自己输入API函数的声明，但VB提供了一种更简单的方法,即使用API Text Viewer。 要想在你的工程中声明API函数，只需运行API Text Viewer,打开Win32api.txt或MDB。

如果你已经把它转换成了数据库的话，这样可以加快速度。 使用预定义的常量和类型也是同样的方法。 API除了有应用“应用程序接口”的意思外，还特指API的说明文档，也称为帮助文档。

扩展资料：

API，往往是和SDK放在一起的。SDK即软件开发工具包。

软件开发工具包是一些被软件工程师用于为特定的软件包、软件框架、硬件平台、操作系统等创建应用软件的开发工具的集合，一般而言SDK即开发 Windows 平台下的应用程序所使用的 SDK。

它可以简单的为某个程序设计语言提供应用程序接口 API的一些文件，但也可能包括能与某种嵌入式系统通讯的复杂的硬件。

一般的工具包括用于调试和其他用途的实用工具。SDK 还经常包括示例代码、支持性的技术注解或者其他的为基本参考资料澄清疑点的支持文档。

参考资料：百度百科- SDK

参考资料：百度百科- API

如何使用 Core Plot 的 API 帮助文档

Core Plot 可是 iOS 下绝好的图表组件，虽说它的相关资料不甚丰富，特别是中文的，英文的还是有几篇不错的文章，不过 Core Plot 自身提供的 API 帮助文档，以及代码示例其实很有用的，不妨且在英文的(注意是英文的) Google 中输入 core plot, 即时搜索出的第一页里的链接很有价值的。

对于 Core Plot 中文资料的缺乏相信很快就会有改观的，譬如说不还有不少像敝人那样的工作者正努力着吗！

既然 Core Plot 为我们提供了文档，那我们就该好好利用好它内在的东西。都是在下载的 CorePlot_0.4.zip 解压后的 CorePlot_0.4 目录中的，Source/examples 下有周到的示例代码，Source/framework  中源代码; Documentation  中便是我们可以查阅的 Core Plot 的 API 帮助文档，有两种使用方式，导入到 Xcode 和浏览器阅读。

1. 集成到 Xcode 的 Organizer-Documentation

在 Mac OS X 中，如果你安装了 Xcode 的话，在 Finder 中看到的 Documentation 目录就是下面那样子：

我们可以看到有两个文件 com.CorePlot.Framework.docset 和 com.CorePlotTouch.framework.docset，假如双击打开它，用了 Xcode 的程序打开，也只能看到右边那个几本书的图标，那我们该如何阅读它呢，办法是把那两个文件拷入到 Xcode 的文档目录，一般是 /Developer/Documentation/DocSets/ 目录。完了之后就可以在 Xcode 的 Organizer-Documentation 窗口中查看 Core Plot 的 API 了。

把帮助文档导入到了 Xcode 之后，可以结合 Xcode 功能快速定位到 API 帮助页面，如 Ctrl+Option+Command+/ 快捷键。

以后在 Mac OS X 下看到 docset 文件要多留份心了，它可能(也应该) 是 Xcode 的帮助文档集，而且从图中也能看到它可以用 doxygen 这个工作来制作生成。

2. 直接用浏览器浏览帮助文档

前面讲的当系统安装了 Xcode 之后，你看到的那两个 com.CorePlot.Framework.docset 和 com.CorePlotTouch.framework.docset 都是文件，其实它们是目录，反正你要信的，不信你就用 Windows 资源管理器来查看，保证它们目录的原形毕露，而且它们之下还有子目录 Contents/Resources/Documents，只要用浏览器打开 Contents/Resources/Documents 中的某一个 HTML 文件就可以看到这样的景象：

这样就可以在浏览器中直接查看 API 了。

关于api帮助文档怎么用和api文档的介绍到此就结束了，不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息，记得收藏关注本站。