class-design-template.md 1.1 KB

类设计说明:【类/模块名】

文档元数据(每次修改必须更新)

字段 值
文档编号 CLS-YYYYMMDD-类名
版本号 v1.0
最后更新日期 YYYY-MM-DD
状态 草稿 / 评审 / 生效 / 废弃
本次变更原因 首次创建 / 设计调整(说明)

一、定位与职责

  • 所属层(组件/服务/模型/工具/数据访问):
  • 一句话职责:
  • 对上游依赖:
  • 对下游影响:

二、职责边界(对照 rules/16-类设计与分层边界.md)

该做的 不该做的(禁止项)

三、接口契约

成员 类型(方法/属性) 入参 出参 说明

四、依赖注入与实例化

  • 注入方式(provideIn root / 构造函数注入):
  • 单例 or 实例:
  • 禁止手动 new 说明:

五、错误处理与错误码

错误码 含义 触发条件

六、测试要点

  • 关键测试用例:
  • 测试文件路径:

七、变更历史

版本 日期 变更内容 变更原因
v1.0 YYYY-MM-DD 首次创建