# 参考文档的组织方式

> CrossFly 参考文档的三个层级，以及每个 API 只有唯一权威出处的单一来源规则。

Source: https://crossfly.dev/zh/docs/reference/overview — CrossFly documentation. Full docs as one file: https://crossfly.dev/llms-full.txt

# 参考文档的组织方式

本节用于**查阅**，而非学习。若要理解某个概念，请前往
[`concepts/`](/docs/concepts)；若要按步骤操作，请前往 [`cookbook/`](/docs/cookbook)。

## 参考文档的三个层级
1. **技术章节**（`../../` 下的 36 个文件）——**规范性的真相**，
   已对照当前源代码审计（2026 审计）。这里保存着"关于 API X 的真相"。
2. **生成的 Javadoc**（`gradle javadoc`）——**精确的签名**，始终与构建保持一致。用于
   查看某个方法的细粒度细节。
3. **精选页面**（本文件夹）——将分散的内容加以整合并**制表**：widget
   目录、`UIConstants` 枚举、速查表、术语表。

## 单一来源规则
每个事实都有**唯一的归属**。如果你在两个地方发现相同的信息，其归属方是**技术章节 /
Javadoc**，其余部分则**链接**到那里（而非重复）。这是蓝图中反重复规则的具体应用。

## ⚠️ Javadoc × 代码：以代码为准
CrossFly 的 Javadoc **在某些地方已过时**（2026 现代化改造移动/重命名了多个
API）。**黄金法则：**出现分歧时，**以源代码和本文档为准，而非孤立的 Javadoc。**
已知的分歧已在受影响的页面中标注（例如：`AlphaAnimation` 在 Javadoc 中显示
`setAlpha`，但真正的方法是 `alpha(float)`）。

## 如何找到你需要的内容
| 你想要… | 前往 |
|---|---|
| 某个布局的 `add()` 签名 | [速查表](/docs/reference/cheat-sheets) |
| 某个枚举的取值（`RelPos`、`EditMode`…） | [枚举与 `UIConstants`](/docs/reference/enums-uiconstants) |
| 某个 widget 的属性 | [Widget 目录](/docs/reference/widget-catalog) |
| 前往某个包/类的 API | [API 索引](/docs/reference/api-reference) |
| 某个术语的含义 | [术语表](/docs/reference/glossary) |