playbook/docs/tsl/reference/index.md

35 lines
1.8 KiB
Markdown

# Reference Index
文档类型:检索页
是否可直接用于生成代码:否
是否含已验证可执行示例:否
是否含已验证反例:否
遇到不确定时跳转到:[catalog/index.md](catalog/index.md)、[../syntax/index.md](../syntax/index.md)、[../finance/index.md](../finance/index.md)
这里是函数查阅层,不是默认通读入口。现在这一页本身就是函数总入口,不再要求先跳到额外的中转页。
## 先看这 5 条
- 这里用于函数查找,不用于建立基础语法模型。
- 不要把 reference 当成默认通读入口;如果任务就是查函数,可以直接从这里开始。
- 函数库规模很大,应先走索引,再做定向检索。
- 如果目录和定向检索都找不到函数,不要默认它是 TSL 内建函数;先回语法层、业务层、模块页或项目文档确认来源。
- 如果你还在问“语言怎么写”,先回 [../syntax/index.md](../syntax/index.md)。
## 检索策略
1. 先看 [catalog/index.md](catalog/index.md) 的模块目录,确定大类。
2. 进入对应模块页,在页内搜索具体函数名。
3. 仍然不确定时,再用 `rg``docs/tsl/reference/catalog/` 做定向搜索。
4. 如果目录和定向检索都找不到函数,不要发明函数名,也不要默认它是 TSL 内建函数;回 [../syntax/index.md](../syntax/index.md)、[../finance/index.md](../finance/index.md)、[../modules/index.md](../modules/index.md) 或项目文档确认来源。
## 按任务跳转
| 当前任务 | 先读哪里 |
| --- | --- |
| 查函数库入口 | [catalog/index.md](catalog/index.md) |
| 直接按模块查函数 | [catalog/index.md](catalog/index.md) |
| 回到语法层 | [../syntax/index.md](../syntax/index.md) |
| 回到金融层 | [../finance/index.md](../finance/index.md) |
| 回到模块层 | [../modules/index.md](../modules/index.md) |