LibRec 学习笔记（六）：手把手教你如何看懂 API 帮助文档

对于小白来说，快速学习并且使用一个新接触的 库 | 框架 | 项目是非常有难度的，比如我们这里的 LibRec 开源库。在我们想要把它用于自己项目的时候，或多或少想要知道某个类是做什么用的，里面有什么方法以及如何去使用。那碰到这种情况，我们普遍的做法除了在搜索引擎里找寻答案，还有一种最简单且直接的方法：直接查询该库 | 框架 | 项目的 API 帮助文档。

一、API

首先解释第一个问题：什么是 API? 百度百科是这样说的：

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

对于这段话，我比较粗暴的理解是对方把所有的类以及方法都写好了，也就是造好了所谓的"轮子"，我们可以直接的把它放进我们的项目中，就能实现对应的功能。

二、API 帮助文档

再来解释第二个问题：什么是API帮助文档？

API 帮助文档就是对 API 中的这些函数写的文档，它可以帮助开发人员了解函数的使用方法和功能，可以极大的便利想要使用该 API 的 开发人员。

在 JAVA 中，API 帮助文档体现形式为 Javadoc 文档，该文档针对整个方法或者整个类做一个简要的概述，使得别人不通过看具体的方法代码就知道某个方法或者某个类的作用和功能。

你可能会问，那 Javadoc 又是什么呢？Javadoc 是 Sun 公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的 API帮助文档，所以这也是为啥很多大的开源项目，代码注释比代码多的原因了！正是为了让使用它的人能够方便的看懂！正所谓助人也助己！

这里所谓的代码的注释是什么呢？实际上在我们使用 Java 语言进行开发的时候，当我们的鼠标悬停在某个类或者某个方法上一般就会有提示信息，而这个提示信息就是源代码上写的注释。我这里截了2张 LibRec 的源代码给大家看下：


则在经过源代码导出的 Javadoc 文档，也就是我们的 LibRec API 文档上我们就可以看到以上的源代码的注释已然写在 API 帮助文档上。

所以在自