# Demo 文档书写规范
Demo 中的控件命名统一采用驼峰大写的形式，不使用分隔符。
Demo 文档需要有 开发者信息、安装、引入、控件 Demo、API。
# 开发者信息
控件基本都是要求有规范进行指导开发，但也存在没有规范的控件
- 没有规范的控件需要说明控件最新版本、开发人员
- 有规范的控件需要说明控件最新版本、开发人员、交互、UI、规范以及规范评审状态。
<!-- 没有规范 -->
<template>
<author-info
version="1.0.0"
author="陈冠彬"
/>
</template>
<!-- 有规范（规范未评审） -->
<template>
<author-info
author="陈冠彬"
ux="潘虹帆"
ui="应源山"
standard="http://10.33.43.73/huidesign/project/issues/57"
/>
</template>
<!-- 有规范（规范已评审） -->
<template>
<author-info
author="陈冠彬"
ux="潘虹帆"
ui="应源山"
standard="http://10.33.43.73/huidesign/project/issues/57"
reviewed
/>
</template>
# 安装 & 引入
目前项目采用 monorepo 模型对每个控件进行单独管理，每个控件都是单独安装和引入的，因此需要在文档里有安装和引入的说明。
安装大同小异，引入时需要注意，若控件有字体图标，需要另起一个 index.scss，修改字体图标的引用路径。
比如 Plan 控件的引入说明：
// main.js
import plan from '@hui-pro/plan';
import './assets/index.scss';
Vue.use(plan);
// assets/index.scss
$--plan-font-path: '~@hui-pro/plan/theme/fonts';
import '~@hui-pro/plan/theme/index.scss';
# 控件 Demo
列出控件的基本用法和最常用的扩展用法，能对开发人员使用控件提供帮助。
# API
API 内容主要包括：
- Attributes（属性）
- Methods（方法）
- Events（事件）
- Slot（插槽）