## 目标 为本次新增/修改的代码片段补充清晰、中文的注释,说明数据来源、字段含义、单位及接口用途,便于后续联调和维护。 ## 注释范围 1. `src/types/types.ts` 中新增的五个接口:`ExtremeValues`、`VehicleLocation`、`VehicleData`、`SubsystemVoltage`、`SubsystemTemperature` 2. `src/api/javaApi.ts` 中新增的五个 API 模块:`javaExtremeValuesApi`、`javaVehicleLocationApi`、`javaVehicleDataApi`、`javaSubsystemVoltageApi`、`javaSubsystemTemperatureApi`,以及聚合导出对象处的说明 3. `.env` 中的 `VITE_JAVA_API_BASE_URL` ## 注释规范 * 语言:中文,与现有文件注释风格一致 * 形式: * 文件/模块级 JSDoc(`/** ... */`)用于整体说明与路由清单 * 字段级行注释(`// ...`)用于标注单位、含义、取值约束 * 不引入冗余内容,仅覆盖本次修改部分 ## 具体变更(按文件) ### 1) src/types/types.ts * 在每个新增接口顶部添加 JSDoc,标注与 SQL 表的映射关系与单位(如电压 V、温度 ℃、经纬度小数位精度)。 * 为关键字段添加行注释: * `timestamp`:UTC ISO 字符串时间戳 * `longitude`/`latitude`:经纬度,保留 7 位小数 * `vehicleStatus`/`chargingStatus`/`operationMode`:取值含义(按后端约定) * `batteryVoltages`/`temperatureValues`:数组单位与含义 示例(片段): ```ts /** * 电池极值数据(表:extreme_values) * 电压单位:V;温度单位:℃;时间戳:UTC ISO 字符串 */ export interface ExtremeValues { id: string; deviceId: string; // 设备ID timestamp: string; // 数据时间戳(UTC ISO) maxVoltageSubsystemNo?: number; // 最高电压子系统号 maxVoltageBatteryNo?: number; // 最高电压单体代号 maxVoltageValue?: number; // 最高电压值(V) ... } ``` ### 2) src/api/javaApi.ts * 在每个新增 API 模块定义前添加模块级 JSDoc,列出路由、用途、返回结构(`ApiResponse` 或数组),并注明 404 时返回 `null` 的约定。 * 在各方法上添加简短 JSDoc:参数说明(`deviceId`、`subsystemNo`、`start/end` 格式)、返回类型含义、列表 `limit` 默认值。 * 在聚合导出对象处添加一行注释,说明已包含设备/电池/OTA/MQTT/系统以及新增数据域模块。 示例(片段): ```ts /** * 极值数据 API * 路由: * - GET /extreme-values/{deviceId}/latest 最新记录 * - GET /extreme-values/{deviceId}?limit= 按设备查询 * - GET /extreme-values/{deviceId}/range?start=&end= 时间范围查询 * - POST /extreme-values 新增记录 */ export const javaExtremeValuesApi = { /** 获取设备最新极值;404 返回 null */ async getLatestByDevice(deviceId: string): Promise { ... }, /** 按设备查询极值列表,limit 默认 100 */ async getByDevice(deviceId: string, limit = 100): Promise { ... }, /** 按时间范围查询,start/end 为 ISO 字符串 */ async getRange(deviceId: string, start: string, end: string): Promise { ... }, /** 新增一条极值记录 */ async addRecord(payload: Omit): Promise { ... } }; // 聚合导出:设备/电池/OTA/MQTT/系统 + 极值/位置/整车/子系统电压/子系统温度 export const javaApi = { ... }; ``` ### 3) .env * 在 `VITE_JAVA_API_BASE_URL` 上方添加一行注释,说明为若依后端基础地址,可按环境切换。 示例(片段): ```env # Java 后端 API 基础地址(若依服务),开发环境可指向 http://localhost:8080 VITE_JAVA_API_BASE_URL=http://localhost:8080 ``` ## 验证与影响 * 仅添加注释,不改动逻辑与类型签名;不会影响编译与运行。 * 重新运行类型检查,确保无语法问题。 ## 需要确认 * 是否按上述规范为本次新增的所有片段添加注释;如需