📝 docs(tsl): clarify tsf-only top-level rules and type annotations
This commit is contained in:
@@ -17,7 +17,8 @@
|
||||
|
||||
### 1.2 文件名与顶层声明(硬约束)
|
||||
|
||||
- TSL 语法要求:每个文件只能有一个顶层声明,且文件基名必须与顶层声明同名。
|
||||
- TSL 语法要求(仅 `.tsf`):每个 `.tsf` 文件只能有一个顶层声明,且文件基名必须与顶层声明同名。
|
||||
- `.tsl` 允许直接写语句,不要求顶层声明;文件名不强制,但建议清晰可检索。
|
||||
- 推荐文件名使用 `PascalCase` 以提升检索与协作一致性;扩展名按类型使用 `.tsl`/`.tsf`(两者都属于 TSL 源文件,风格规则一致)。
|
||||
- 详细约束与命名细则见 `docs/tsl/naming.md`。
|
||||
|
||||
@@ -177,7 +178,8 @@ end;
|
||||
### 4.2 函数设计
|
||||
|
||||
- 签名尽量自解释:对外 API 的参数/返回值建议显式写类型注解;并用注释写清契约(可复用 3.2 的模板)。
|
||||
- 无返回值函数显式标注返回类型为 `void`。
|
||||
- 类型注解不支持 `xxx.xxx` 形式;使用单一类型名。
|
||||
- 无返回值函数显式标注返回类型为 `void`;`create`/`destroy` 作为构造/析构函数不写返回类型。
|
||||
|
||||
```tsl
|
||||
function Func(a: string; b: ClassName): void;
|
||||
|
||||
Reference in New Issue
Block a user