@ohos-cpf/3rdloop 0.0.1 → 0.0.3

package/vendor/Server/Skills/flutter-interface/references/TEMPLATE.md

@@ -1,254 +1,254 @@
-# Library Interface Analyzer - 文档模板
-
-本模板可用于手动创建接口规格说明文档。
-
----
-
-# [库名]接口规格说明
-
-## 1. 三方库概述
-
-[在此填写库的功能介绍，包括主要特性、适用场景等，3-5 句话即可]
-
-示例：
-> XXX 是一个轻量级的 JavaScript 工具库，提供了常用的字符串、数组和对象操作函数。它支持 ES6+ 语法，可在浏览器和 Node.js 环境中使用。主要特性包括：链式调用、按需引入、零依赖。
-
----
-
-## 2. 对外导出的类
-
-> 如果没有导出类，可以省略此章节
-
-### 2.1 [类名1]
-
-| 序号 | 类名/成员 | 方法/属性 | 功能描述 |
-|------|-----------|-----------|----------|
-| 1    | [类名1] | constructor([参数列表]) | [构造函数的功能描述] |
-| 2    |         | [方法名1]([参数列表]): [返回值类型] | [方法的功能描述] |
-| 3    |         | [方法名2]([参数列表]): [返回值类型] | [方法的功能描述] |
-| 4    |         | [属性名1]: [属性类型] | [属性的功能描述] |
-| 5    |         | [属性名2]: [属性类型] | [属性的功能描述] |
-
-### 2.2 [类名2]
-
-| 序号 | 类名/成员 | 方法/属性 | 功能描述 |
-|------|-----------|-----------|----------|
-| 1    | [类名2] | constructor([参数列表]) | [构造函数的功能描述] |
-| ...  | ...     | ...       | ...      |
-
-> 如果有更多类，继续添加表格
-
----
-
-## 3. 对外导出的接口/类型（TypeScript）
-
-> 仅 TypeScript 库适用；如果没有导出接口/类型，可以省略此章节
-
-### 3.1 [接口名1]
-
-| 序号 | 接口/类型名 | 字段 | 类型 | 必填 | 描述 |
-|------|------------|------|------|------|------|
-| 1    | [接口名1] | [字段名1] | [类型] | 是 | [字段描述] |
-| 2    |            | [字段名2?] | [类型] | 否 | [可选字段描述] |
-| ...  | ...        | ...   | ...  | ...  | ...  |
-
-### 3.2 [类型别名1]
-
-> `type` 别名可直接描述其等价类型
-
-| 序号 | 类型名 | 等价类型 | 功能描述 |
-|------|--------|----------|----------|
-| 1    | [类型名1] | [等价类型] | [类型的功能描述] |
-
----
-
-## 4. 对外导出的枚举
-
-> 如果没有导出枚举，可以省略此章节
-
-| 序号 | 枚举名称 | 成员名 | 值 | 功能描述 |
-|------|----------|--------|-----|----------|
-| 1    | [枚举名1] | [成员名1] | [值] | [枚举整体描述] |
-| 2    |          | [成员名2] | [值] | [成员描述] |
-| 3    | [枚举名2] | [成员名1] | [值] | [枚举整体描述] |
-
----
-
-## 5. 对外导出的函数
-
-> 如果没有导出函数，可以省略此章节
-
-| 序号 | 函数名称 | 返回值 | 参数列表 | 功能描述 |
-|------|----------|--------|----------|----------|
-| 1    | [函数名1] | [返回值类型] | [参数1: 类型1, 参数2: 类型2, ...] | [函数的功能描述] |
-| 2    | [函数名2] | [返回值类型] | [参数列表] | [函数的功能描述] |
-| 3    | [函数名3] | [返回值类型] | [参数列表] | [函数的功能描述] |
-
----
-
-## 6. 对外导出的变量
-
-> 如果没有导出变量，可以省略此章节
-
-| 序号 | 变量名称 | 变量类型 | 功能描述 |
-|------|----------|----------|----------|
-| 1    | [变量名1] | [变量类型] | [变量的功能描述] |
-| 2    | [变量名2] | [变量类型] | [变量的功能描述] |
-
----
-
-## 7. 注意事项
-
-> 如果没有特殊注意事项，可以省略此章节
-
-- [注意事项1：例如使用限制、兼容性问题等]
-- [注意事项2：例如依赖的环境、需要的配置等]
-- [注意事项3：例如性能考虑、已知问题等]
-
-示例：
-- 本库依赖 ES6+ 环境，不支持 IE11 及更早版本
-- 部分函数使用了 Node.js 内置模块，不能在浏览器环境中使用
-- 深拷贝函数不支持循环引用的对象
-- 异步函数均返回 Promise，需要注意错误处理
-
----
-
-## 填写说明
-
-### 类（Classes）
-每个类一个表格，包含：
-- **构造函数**: 第一行，展示如何创建实例
-- **方法**: 按重要性排序，包含参数和返回值类型；**静态方法需标注 `static`**
-- **属性**: 公开可访问的属性；`private`/`protected` 成员不包含
-
-**示例**:
-```
-| 序号 | 类名/成员 | 方法/属性 | 功能描述 |
-|------|-----------|-----------|----------|
-| 1    | HttpClient | constructor(baseURL: string, timeout?: number) | 创建 HTTP 客户端实例 |
-| 2    |           | get(url: string, options?: RequestOptions): Promise<Response> | 发送 GET 请求 |
-| 3    |           | static create(baseURL: string): HttpClient | 静态工厂方法 |
-| 4    |           | timeout: number | 请求超时时间（毫秒） |
-```
-
-### 接口/类型（Interfaces/Types）
-导出的 `interface` 或 `type` 别名：
-- **必填字段**: 无 `?` 修饰符
-- **可选字段**: 字段名带 `?`，展示为 `field?`
-- **注意**: TypeScript 库的 `.d.ts` 文件是最权威的来源
-
-**示例**:
-```
-| 序号 | 接口/类型名 | 字段 | 类型 | 必填 | 描述 |
-|------|------------|------|------|------|------|
-| 1    | RequestOptions | timeout? | number | 否 | 请求超时时间 |
-| 2    |                | headers? | Record<string, string> | 否 | 自定义请求头 |
-```
-
-### 枚举（Enums）
-导出的枚举应列出所有成员及对应值：
-- 同一枚举的所有成员在表格中共用一个枚举名单元格，其余为空
-
-**示例**:
-```
-| 序号 | 枚举名称 | 成员名 | 值 | 功能描述 |
-|------|----------|--------|-----|----------|
-| 1    | HttpMethod | GET | 'get' | HTTP GET 方法 |
-| 2    |            | POST | 'post' | HTTP POST 方法 |
-```
-
-### 函数（Functions）
-所有导出的独立函数：
-- **函数名称**: 准确的函数名
-- **返回值**: 返回值的类型
-- **参数列表**: 包含参数名和类型，可选参数用 `?` 标记
-- **功能描述**: 简短的功能说明
-
-**示例**:
-```
-| 序号 | 函数名称 | 返回值 | 参数列表 | 功能描述 |
-|------|----------|--------|----------|----------|
-| 1    | debounce | Function | fn: Function, delay: number | 函数防抖，延迟执行 |
-```
-
-### 变量（Variables）
-导出的常量或配置对象：
-- **变量名称**: 通常使用大写和下划线
-- **变量类型**: 基本类型或对象类型
-- **功能描述**: 变量的用途
-
-**示例**:
-```
-| 序号 | 变量名称 | 变量类型 | 功能描述 |
-|------|----------|----------|----------|
-| 1    | VERSION | string | 库的版本号 |
-| 2    | DEFAULT_CONFIG | object | 默认配置对象 |
-```
-
-### 注意事项
-包括但不限于：
-- 环境要求（浏览器、Node.js 版本等）
-- 使用限制（不支持的特性、边界情况等）
-- 依赖关系（需要的外部库或工具）
-- 性能考虑（大数据量的处理、内存占用等）
-- 已知问题（bug、待完善的功能等）
-- 最佳实践（推荐的使用方式）
-
----
-
-## 参数表示法
-
-### TypeScript 风格
-```
-参数名: 类型
-可选参数?: 类型
-默认参数: 类型 = 默认值
-```
-
-示例：
-- `url: string`
-- `timeout?: number`
-- `method: 'GET' | 'POST' = 'GET'`
-
-### JavaScript 风格（JSDoc）
-```
-参数名: 类型
-可选参数 (可选)
-```
-
-示例：
-- `url: String`
-- `timeout: Number (可选)`
-
-### Python 风格
-```
-参数名: 类型
-可选参数: 类型 = 默认值
-```
-
-示例：
-- `text: str`
-- `encoding: str = 'utf-8'`
-
----
-
-## 类型表示法
-
-常见类型：
-- **基本类型**: string, number, boolean, null, undefined
-- **对象类型**: object, Object, any
-- **数组类型**: Array, Array<T>, T[]
-- **函数类型**: Function, (args) => returnType
-- **联合类型**: string | number
-- **泛型**: T, <T>
-
----
-
-## 保存文件
-
-文件名格式: `[库名]接口规格说明.md`
-
-例如：
-- `lodash接口规格说明.md`
-- `axios接口规格说明.md`
-- `react接口规格说明.md`
+# Library Interface Analyzer - 文档模板
+
+本模板可用于手动创建接口规格说明文档。
+
+---
+
+# [库名]接口规格说明
+
+## 1. 三方库概述
+
+[在此填写库的功能介绍，包括主要特性、适用场景等，3-5 句话即可]
+
+示例：
+> XXX 是一个轻量级的 JavaScript 工具库，提供了常用的字符串、数组和对象操作函数。它支持 ES6+ 语法，可在浏览器和 Node.js 环境中使用。主要特性包括：链式调用、按需引入、零依赖。
+
+---
+
+## 2. 对外导出的类
+
+> 如果没有导出类，可以省略此章节
+
+### 2.1 [类名1]
+
+| 序号 | 类名/成员 | 方法/属性 | 功能描述 |
+|------|-----------|-----------|----------|
+| 1    | [类名1] | constructor([参数列表]) | [构造函数的功能描述] |
+| 2    |         | [方法名1]([参数列表]): [返回值类型] | [方法的功能描述] |
+| 3    |         | [方法名2]([参数列表]): [返回值类型] | [方法的功能描述] |
+| 4    |         | [属性名1]: [属性类型] | [属性的功能描述] |
+| 5    |         | [属性名2]: [属性类型] | [属性的功能描述] |
+
+### 2.2 [类名2]
+
+| 序号 | 类名/成员 | 方法/属性 | 功能描述 |
+|------|-----------|-----------|----------|
+| 1    | [类名2] | constructor([参数列表]) | [构造函数的功能描述] |
+| ...  | ...     | ...       | ...      |
+
+> 如果有更多类，继续添加表格
+
+---
+
+## 3. 对外导出的接口/类型（TypeScript）
+
+> 仅 TypeScript 库适用；如果没有导出接口/类型，可以省略此章节
+
+### 3.1 [接口名1]
+
+| 序号 | 接口/类型名 | 字段 | 类型 | 必填 | 描述 |
+|------|------------|------|------|------|------|
+| 1    | [接口名1] | [字段名1] | [类型] | 是 | [字段描述] |
+| 2    |            | [字段名2?] | [类型] | 否 | [可选字段描述] |
+| ...  | ...        | ...   | ...  | ...  | ...  |
+
+### 3.2 [类型别名1]
+
+> `type` 别名可直接描述其等价类型
+
+| 序号 | 类型名 | 等价类型 | 功能描述 |
+|------|--------|----------|----------|
+| 1    | [类型名1] | [等价类型] | [类型的功能描述] |
+
+---
+
+## 4. 对外导出的枚举
+
+> 如果没有导出枚举，可以省略此章节
+
+| 序号 | 枚举名称 | 成员名 | 值 | 功能描述 |
+|------|----------|--------|-----|----------|
+| 1    | [枚举名1] | [成员名1] | [值] | [枚举整体描述] |
+| 2    |          | [成员名2] | [值] | [成员描述] |
+| 3    | [枚举名2] | [成员名1] | [值] | [枚举整体描述] |
+
+---
+
+## 5. 对外导出的函数
+
+> 如果没有导出函数，可以省略此章节
+
+| 序号 | 函数名称 | 返回值 | 参数列表 | 功能描述 |
+|------|----------|--------|----------|----------|
+| 1    | [函数名1] | [返回值类型] | [参数1: 类型1, 参数2: 类型2, ...] | [函数的功能描述] |
+| 2    | [函数名2] | [返回值类型] | [参数列表] | [函数的功能描述] |
+| 3    | [函数名3] | [返回值类型] | [参数列表] | [函数的功能描述] |
+
+---
+
+## 6. 对外导出的变量
+
+> 如果没有导出变量，可以省略此章节
+
+| 序号 | 变量名称 | 变量类型 | 功能描述 |
+|------|----------|----------|----------|
+| 1    | [变量名1] | [变量类型] | [变量的功能描述] |
+| 2    | [变量名2] | [变量类型] | [变量的功能描述] |
+
+---
+
+## 7. 注意事项
+
+> 如果没有特殊注意事项，可以省略此章节
+
+- [注意事项1：例如使用限制、兼容性问题等]
+- [注意事项2：例如依赖的环境、需要的配置等]
+- [注意事项3：例如性能考虑、已知问题等]
+
+示例：
+- 本库依赖 ES6+ 环境，不支持 IE11 及更早版本
+- 部分函数使用了 Node.js 内置模块，不能在浏览器环境中使用
+- 深拷贝函数不支持循环引用的对象
+- 异步函数均返回 Promise，需要注意错误处理
+
+---
+
+## 填写说明
+
+### 类（Classes）
+每个类一个表格，包含：
+- **构造函数**: 第一行，展示如何创建实例
+- **方法**: 按重要性排序，包含参数和返回值类型；**静态方法需标注 `static`**
+- **属性**: 公开可访问的属性；`private`/`protected` 成员不包含
+
+**示例**:
+```
+| 序号 | 类名/成员 | 方法/属性 | 功能描述 |
+|------|-----------|-----------|----------|
+| 1    | HttpClient | constructor(baseURL: string, timeout?: number) | 创建 HTTP 客户端实例 |
+| 2    |           | get(url: string, options?: RequestOptions): Promise<Response> | 发送 GET 请求 |
+| 3    |           | static create(baseURL: string): HttpClient | 静态工厂方法 |
+| 4    |           | timeout: number | 请求超时时间（毫秒） |
+```
+
+### 接口/类型（Interfaces/Types）
+导出的 `interface` 或 `type` 别名：
+- **必填字段**: 无 `?` 修饰符
+- **可选字段**: 字段名带 `?`，展示为 `field?`
+- **注意**: TypeScript 库的 `.d.ts` 文件是最权威的来源
+
+**示例**:
+```
+| 序号 | 接口/类型名 | 字段 | 类型 | 必填 | 描述 |
+|------|------------|------|------|------|------|
+| 1    | RequestOptions | timeout? | number | 否 | 请求超时时间 |
+| 2    |                | headers? | Record<string, string> | 否 | 自定义请求头 |
+```
+
+### 枚举（Enums）
+导出的枚举应列出所有成员及对应值：
+- 同一枚举的所有成员在表格中共用一个枚举名单元格，其余为空
+
+**示例**:
+```
+| 序号 | 枚举名称 | 成员名 | 值 | 功能描述 |
+|------|----------|--------|-----|----------|
+| 1    | HttpMethod | GET | 'get' | HTTP GET 方法 |
+| 2    |            | POST | 'post' | HTTP POST 方法 |
+```
+
+### 函数（Functions）
+所有导出的独立函数：
+- **函数名称**: 准确的函数名
+- **返回值**: 返回值的类型
+- **参数列表**: 包含参数名和类型，可选参数用 `?` 标记
+- **功能描述**: 简短的功能说明
+
+**示例**:
+```
+| 序号 | 函数名称 | 返回值 | 参数列表 | 功能描述 |
+|------|----------|--------|----------|----------|
+| 1    | debounce | Function | fn: Function, delay: number | 函数防抖，延迟执行 |
+```
+
+### 变量（Variables）
+导出的常量或配置对象：
+- **变量名称**: 通常使用大写和下划线
+- **变量类型**: 基本类型或对象类型
+- **功能描述**: 变量的用途
+
+**示例**:
+```
+| 序号 | 变量名称 | 变量类型 | 功能描述 |
+|------|----------|----------|----------|
+| 1    | VERSION | string | 库的版本号 |
+| 2    | DEFAULT_CONFIG | object | 默认配置对象 |
+```
+
+### 注意事项
+包括但不限于：
+- 环境要求（浏览器、Node.js 版本等）
+- 使用限制（不支持的特性、边界情况等）
+- 依赖关系（需要的外部库或工具）
+- 性能考虑（大数据量的处理、内存占用等）
+- 已知问题（bug、待完善的功能等）
+- 最佳实践（推荐的使用方式）
+
+---
+
+## 参数表示法
+
+### TypeScript 风格
+```
+参数名: 类型
+可选参数?: 类型
+默认参数: 类型 = 默认值
+```
+
+示例：
+- `url: string`
+- `timeout?: number`
+- `method: 'GET' | 'POST' = 'GET'`
+
+### JavaScript 风格（JSDoc）
+```
+参数名: 类型
+可选参数 (可选)
+```
+
+示例：
+- `url: String`
+- `timeout: Number (可选)`
+
+### Python 风格
+```
+参数名: 类型
+可选参数: 类型 = 默认值
+```
+
+示例：
+- `text: str`
+- `encoding: str = 'utf-8'`
+
+---
+
+## 类型表示法
+
+常见类型：
+- **基本类型**: string, number, boolean, null, undefined
+- **对象类型**: object, Object, any
+- **数组类型**: Array, Array<T>, T[]
+- **函数类型**: Function, (args) => returnType
+- **联合类型**: string | number
+- **泛型**: T, <T>
+
+---
+
+## 保存文件
+
+文件名格式: `[库名]接口规格说明.md`
+
+例如：
+- `lodash接口规格说明.md`
+- `axios接口规格说明.md`
+- `react接口规格说明.md`