---
next:
  text: Public API
  link: /zh-cn/api/public/com/highcapable/yukihookapi/YukiHookAPI
---

# 文档介绍

> 这里的文档将同步最新 API 版本的相关用法，请保持 `YukiHookAPI` 为最新版本以使用最新版本的功能。

::: warning

由于维护成本，`YukiHookAPI` 从 `1.3.0` 版本开始将不再会对此文档进行更新且在 `2.0.0` 版本切换为 Dokka 插件自动生成的 API 文档，如遇到无法解决的问题，你可以通过 [联系我们](../about/contacts) 与我们联系。

:::

## 功能描述说明

> 功能描述主要介绍当前 API 的相关用法和用途。

## 功能示例说明

> 功能示例主要展示了当前 API 的基本用法示例，可供参考。

## 变更记录说明

首个版本的功能将标记为 `v<version>` `添加`；

后期新增加的功能将标记为 `v<version>` `新增`；

后期修改的功能将被追加为 `v<version>` `修改`；

后期被作废的功能将标记为 `v<version>` `作废` 并会标注删除线；

后期被删除的功能将标记为 `v<version>` `移除` 并会标注删除线。

## 相关符号说明

- *kt* &nbsp;Kotlin Static File

- *annotation* &nbsp;注解

- *interface* &nbsp;接口

- *object* &nbsp;类 (单例)

- *class* &nbsp;类

- *field* &nbsp;变量或 `get`、`set` 方法或只读的 `get` 方法

- *method* &nbsp;方法

- *enum* &nbsp;Enum 常量

- *ext-field* &nbsp;扩展的变量 (全局)

- *ext-method* &nbsp;扩展的方法 (全局)

- *i-ext-field* &nbsp;扩展的变量 (调用域限制)

- *i-ext-method* &nbsp;扩展的方法 (调用域限制)