50 lines
1.2 KiB
Markdown
50 lines
1.2 KiB
Markdown
# TPL-03 语法或 API 参考
|
|
|
|
用途：直接查询精确写法、输入和行为。适用规则：DOC-004、008、012、013、015、017、019。
|
|
|
|
## 内容顺序
|
|
|
|
````markdown
|
|
# 声明、表达式或组件名称
|
|
|
|
一段定义与用途，连接必要概念，不重讲整个教程。
|
|
|
|
## 形式
|
|
|
|
给出签名或语法结构。
|
|
完整 EBNF 已有主来源时连接其区域，不建立另一套版本。
|
|
|
|
## 参数与类型
|
|
|
|
按名称、位置、类型、默认值和含义组织。
|
|
没有默认值时明确说明；未确定的默认值保持提案状态。
|
|
|
|
## 结果与效果
|
|
|
|
说明返回值、结构、依赖及影响行为的阶段要求。
|
|
|
|
## 约束与失败
|
|
|
|
写出数量、类型、结构或结果状态边界。
|
|
区分静态诊断与执行失败。
|
|
|
|
## 示例
|
|
|
|
最小有效例子、预期结果和必要前提。
|
|
不将占位符或假设成员写成实际可用 API。
|
|
|
|
## 相关定义
|
|
|
|
连接主定义、提案状态和必要主题。
|
|
````
|
|
|
|
## 一致性
|
|
|
|
同类参考页使用相近字段，但没有意义的字段不凑齐。组件的“子节点约束”比没有函数返回值时强填“返回”更合适。
|
|
|
|
## 完成条件
|
|
|
|
跳入该页的读者能查到形式、合法输入及效果，所有假设可见。
|
|
|
|
[模板目录](README.md)
|