Files
tsl-devkit/docs/tsl/syntax/02_quickstart.md
T
csh 3d83740f88 Squashed 'docs/standards/playbook/' changes from c3f8137..25d895d
25d895d 🐛 fix(gitea_workflow): clean up temp repos after job steps
2bc3b11 🐛 fix(gitea_workflow): clean up temporary repo dirs in workflows
98c3f30 📝 docs(agent_rules): allow plan execution on current branch
16c7230 📝 docs(prompts): define custom verify layering
8efc4dd 🐛 fix(skills): quote commit-message description
bc8498f 🐛 fix(ci): install tomli for gitea tests
55cda3b 🐛 fix(tests): report missing toml parser clearly
c0729c7 🐛 fix(playbook): import Optional for cli compatibility
63e24bf 📦 deps(skills): sync thirdparty skills
d2f9356 🐛 fix(ci): isolate gitea workflow repos
588b81d 🐛 fix(ci): inline gitea workflow bootstrap
e0b1c3a ♻️ refactor(skills): standardize first-party skill contracts
2c5050d ♻️ refactor(skills): rename repo skills source dir
f049dfb 📦 deps(skills): drop duplicate first-party superpowers skills
234b335  feat(workflow): add superpowers planning and execution state tracking
c1702a6 📝 docs(markdown): format tracked markdown and drop stale templates
2325409 📝 docs(markdown): clarify optional markdownlint usage
214c44e 🔧 chore(markdown): add markdownlint baseline and lint fixes
a22b324 📝 docs(templates): add execution and memory-bank prompt templates
223a797 📝 docs(templates): update README for Claude Code and current features
4ac8672 📝 docs: simplify README + platform-agnostic tools + auto-create local rules
2431c9d 📝 docs: add claude_md config and use cross-platform paths
d64b248 📝 docs: fix README.md inaccuracies and add Claude Code info
c8d6bf2 🐛 fix(playbook): use relative paths in CLAUDE.md when not at project root
6518f0f  feat(playbook): auto-create CLAUDE.md with path discovery
6ec9a45  feat(skills): add skill_link symlink support + platform-agnostic prompt
9f8b6b5 📝 docs: update README and config example for Claude Code support
79cff6c 📝 docs(skills): add Claude Code platform support
452c6f5  feat(playbook): auto-inject AGENTS.md into CLAUDE.md
e1dbf3c 🐛 fix(skills): remove dual-path from commit-message skill
f3a7259 🔧 chore(ci): use prepare_repo.sh in both workflows
da08212 🔧 chore(ci): extract prepare_repo.sh and clean up workflows
7ade85e 🗑️ remove(tsl): drop syntax_book/, data/ source and build script
f94dba0 ♻️ refactor(skills): update playbook.py and tests for thirdparty/ layout
b3df412 ♻️ refactor(skills): separate thirdparty skills into thirdparty/ subdirectory
64950e7 📦 deps(skills): sync thirdparty skills
a2e3cb0  feat(playbook): add no_backup deploy controls
8609d59 🐛 fix(docs): repair reference catalog source links
956da11 🐛 fix(playbook): publish hidden ci test fixes
3f67754 📦 deps(skills): sync thirdparty skills
08ca87b 📦 deps(skills): add karpathy thirdparty sync
96b705b 📝 docs(tsl): rebuild canonical syntax and routing manual
3ed5052 📦 deps(skills): sync thirdparty skills
60108dd 📦 deps(skills): sync thirdparty skills
da85d4e 🐛 fix(thirdparty): prune nested project snapshots
a2a697e 📦 deps(skills): sync thirdparty skills
9df610a 🐛 fix(thirdparty): exclude duplicated superpowers skills
33dd5bb 🐛 fix(thirdparty): preserve optional manifest fields
91b0ea7 🐛 fix(thirdparty): preserve manifest during snapshot update
2e26f98 🔧 chore(thirdparty): generalize skills sync pipeline
5b9c1e3 📦 deps(skills): sync superpowers
2f2d34a 📝 docs(readme): normalize subtree command spacing
62db7db 🐛 fix(ci): serialize superpowers update and sync
3463223 🐛 fix(ci): use literal superpowers sync paths
48f6de8 📦 deps(skills): sync superpowers
4b23529 🔧 chore(ci): merge superpowers update and sync workflow
a56d75b 📦 deps(skills): sync superpowers
84bcefa 🔧 chore(ci): use ci[bot] commit author name
00a07e5 📦 deps(skills): sync superpowers
7b84daf 🐛 fix(templates): enforce main loop progress tracking
51373d7 🔧 chore(ci): automate superpowers sync workflow
eaaa39c 🐛 fix(ci): prevent stale superpowers sync from restoring skills block
79755c6 📦 deps(skills): sync superpowers
836d878 📦 deps(skills): sync superpowers
8216c9f 📦 deps(skills): sync superpowers
9439505 🐛 fix(playbook): address reported repo issues

git-subtree-dir: docs/standards/playbook
git-subtree-split: 25d895d8b3f56624ccfe99ad7289e9eb49e0f316
2026-05-24 13:04:14 +08:00

133 lines
4.2 KiB
Markdown

# Syntax Quickstart
文档类型:语法主线
是否可直接用于生成代码:是
是否含已验证可执行示例:是
是否含已验证反例:是
遇到不确定时跳转到:[03_core_model.md](03_core_model.md)、[06_functions_and_calls.md](06_functions_and_calls.md)、[10_units_and_scope.md](10_units_and_scope.md)
手册位置:第 2 篇,共 32 篇。上一篇:[01_introduction.md](01_introduction.md)。下一篇:[03_core_model.md](03_core_model.md)。
这一篇集中回答两个紧邻问题:现在要写 TSL 时,应该从哪一种最短骨架起手;以及落代码前必须先核对哪些语言硬规则。
## 这一篇解决什么问题
快速回答“当前任务应该从松散语句、函数、类还是 unit 开始”,并提供一份单点的语言核心事实速查。
## 语言核心事实速查
这一节是当前语法手册默认的语言硬规则收口点。涉及赋值、顶层外形、命名参数、类写法、`unit` 骨架和下标规则时,统一先看这里。
- 普通赋值用 `:=`,不要把 `=` 当成普通赋值。
- 顶层主体先按四类理解:松散语句、`function / procedure``type Name = class``unit`
- 如果当前文件采用顶层 `function / procedure` 模型,就不要再混入松散语句。
- 无返回值时用 `procedure Name(...); begin ... end;`,不要勉强用 `function`
- 顶层类定义统一写成 `type Name = class ... end;`,不要写裸 `class Name`
- 多文件组织默认先按 `unit Name; interface ... implementation ... end.` 理解。
- 命名参数写法是 `Func(a:1, b:2)`
- `array(...)` 既可以写顺序数组,也可以写字符串键表;数组下标从 `0` 开始,字符串下标从 `1` 开始。
## 术语对照
- 文档里出现的“顶层 `function / procedure`”“顶层函数骨架”“顶层函数定义体”,指的是同一类顶层模型:文件以顶层 `function` / `procedure` 为主体。
- 文档里出现的 `class function` 和“类方法”,指的是同一件事:前者是代码关键字写法,后者是中文描述。
## 先选哪一种骨架
| 当前任务 | 起手骨架 |
| ------------------------------ | ------------------- |
| 只写一段一次性脚本逻辑 | 顶层松散语句 |
| 先沉淀一个可复用逻辑块 | 顶层 `function` |
| 需要对象状态、字段、方法 | `type Name = class` |
| 需要把接口和实现组织进一个模块 | `unit` |
默认建议:
- 如果你只是要让新 session 先写出一段最稳、最容易续写的基础语法,优先从顶层 `function` 开始。
- `uses` 往往天然进入多文件查找路径问题,所以不放进这篇的最小起手骨架里。
## 已验证最小骨架
顶层松散语句骨架:
代码块身份:已验证可执行示例
```tsl
a := 1;
```
顶层函数骨架:
代码块身份:已验证可执行示例
```tsl
function Demo();
begin
return 1;
end;
```
顶层类骨架:
代码块身份:已验证可执行示例
```tsl
type DemoType = class
end;
```
顶层 `unit` 骨架:
代码块身份:已验证可执行示例
```tsl
unit DemoUnit;
interface
function Ping();
implementation
function Ping();
begin
return 1;
end;
end.
```
## 最常用起手版本
如果你现在没有明确的多文件或对象建模需求,直接从函数版本开始:
代码块身份:已验证可执行示例
```tsl
function Hello();
begin
return 1;
end;
```
## 最容易写错的一件事
- 不要把“顶层函数定义”和“顶层松散语句”混写在同一个最小文件里。
代码块身份:反例 / 不可照写
```text
function Add(a, b);
begin
return a + b;
end;
value := Add(1, 2);
```
上面这种“先定义顶层函数,再接松散语句”的混合写法会编译失败。
## 跳转指引
- 先建立整体读法:见 [01_introduction.md](01_introduction.md)
- 继续判断顶层模型:见 [03_core_model.md](03_core_model.md)
- 继续写函数:见 [06_functions_and_calls.md](06_functions_and_calls.md)
- 继续写 `unit` / `uses`:见 [10_units_and_scope.md](10_units_and_scope.md)
- 继续写类:见 [09_objects_and_classes.md](09_objects_and_classes.md)