前端组件文档编写规范书.docVIP

前端组件文档编写规范书

一、文档核心结构规范

（一）基础信息模块

基础信息是组件文档的“身份证”，需清晰展示组件的核心属性，让开发者快速定位组件用途。

组件名称：采用PascalCase命名法，如DatePicker、TablePagination，确保与代码中组件类名一致，避免歧义。

组件类型：明确分类，如“基础组件”“表单组件”“数据展示组件”“业务组件”，便于开发者按场景检索。

适用场景：结合业务场景描述，例如“适用于需要用户选择单个或多个日期的表单场景，如订单创建时间筛选、会议日程预约”，避免模糊表述。

版本信息：记录组件当前版本、首次发布版本及更新日志链接，如v2.3.0（2025-03-15），帮助开发者了解迭代历史。

维护责任人：标注组件的开发负责人及联系方式，方便问题反馈与协作。

（二）API文档模块

API是组件的“操作手册”，需精确、完整地定义组件的输入输出，确保开发者正确调用。

1.属性（Props）

以表格形式呈现，包含以下字段：|属性名|类型|默认值|必填|说明||||||||value|string/number||是|组件的绑定值，如输入框内容、选择器选中值||disabled|boolean|false|否|是否禁用组件，禁用后用户无法交互||size|small/medium/large|m