Skip to content

Latest commit

 

History

History
26 lines (19 loc) · 2.09 KB

File metadata and controls

26 lines (19 loc) · 2.09 KB

VChart 工程基准

VChart 是高性能可视化渲染库。工程取舍应优先面向正确、文档化的调用方式:快速的 render/update/release 路径、稳定可预期的 API,以及可用、易用的图表行为。

编码习惯

  • 不要在热路径中加入大量宽泛的防御式兜底,除非它保护的是明确记录的公共 API 契约,或有真实兼容性需求支撑。
  • 优先使用清晰契约,而不是静默归一化。内部非法状态应通过测试或边界校验暴露,不应被每个图元运行时 guard 隐藏。
  • per-graphic 的 render/update/state 代码应尽量少分配、少分支。避免不必要的数组创建、对象重建、深比较、resolver 失效、状态清理或重复生命周期工作。
  • 按 VRender API 的预期契约调用。除非存在明确的跨版本兼容理由,不要在 VChart 侧包一层本地兜底逻辑。
  • 当项目已有标准工具、公共 API 或统一封装能表达同一行为时,必须优先收敛到标准写法;如果标准写法无法满足需求,应修正标准工具或上游契约,而不是在调用点维护多套等价或异化实现。暴露并修复标准路径问题,优先于用局部特例掩盖问题。
  • 公共 API 边界要保持易用性,但内部路径不需要长期容忍非标准调用方。
  • 性能是大数据与多图 dashboard 场景下的正确性维度。修改 render、update、state、animation、release 路径时,需要考虑 10k 图元和多 chart 页面。
  • 测试应锁定有效用法下的预期行为。不要把偶然用法或不支持用法固化成兼容承诺,除非该行为已经被明确纳入 API。

文档规范

  • 当前项目文档优先使用中文编写。
  • 面向外部生态或已有多语言体系的文档,可按现有文档结构补充对应语言版本,但中文说明应优先完整、准确。

优先级

  1. 有效 spec 和文档化 API 下的正确渲染。
  2. render、update、interaction、animation、release 的高性能。
  3. 稳定且易用的公共调用方式。
  4. 最小化兼容性兜底,只在真实 API 承诺需要时引入。