44 lines
1.2 KiB
Markdown
44 lines
1.2 KiB
Markdown
# TPL-01 概念指南
|
|
|
|
用途：读者首次理解某个概念，知道它的基本形式和行为。适用规则：DOC-001、003、004、005、010、013、015、018。
|
|
|
|
## 内容顺序
|
|
|
|
````markdown
|
|
# 主题名称
|
|
|
|
定义：对象是什么，在应用中承担什么职责。
|
|
|
|
## 前置知识
|
|
|
|
只列理解本页必需的概念与实际链接。已经由全书说明的前提不重复堆叠。
|
|
|
|
## 基本形式
|
|
|
|
展示最小形式，并解释组成部分。
|
|
|
|
## 示例
|
|
|
|
标明代码归属与使用位置；给出声明或片段。
|
|
展示预期结果或效果，说明导致结果的关键规则。
|
|
|
|
## 使用约束
|
|
|
|
说明相关类型、结构与依赖；阶段差异影响理解时再说明阶段。
|
|
未定能力在使用点短注，并链接实际的规范状态区域。
|
|
|
|
## 延伸
|
|
|
|
连接下一步和精确参考，不复制相关章节。
|
|
````
|
|
|
|
## 删除不适用栏目
|
|
|
|
若页面只介绍身份或 namespace，不强行提供函数代码或计算结果。使用 key 对照与定位示例即可。前置知识简单时可融入首段。
|
|
|
|
## 完成条件
|
|
|
|
读者可以复述概念职责、识别基本形式并解释一个例子。主要定义没有被复制为多份权威版本。
|
|
|
|
[模板目录](README.md)
|