组件说明
组件说明是团队成员在使用组件库内的组件时可进行参考的文档。在组件说明中可以对某一组件撰写说明,如果组件中使用了可覆写的变量或与外部有消息收发上的交互,那么这些条目会被自动添加到文档中。
编辑
在组件库右侧的属性面板中点击组件说明的编辑按钮即可对组件说明的内容进行编辑,组件说明支持使用Markdown语法(超链接、图像及表格类语法除外)。
![[object Object]](https://cdn.sanity.io/images/vidqzkll/production/7919070a94f461a8359a815873ed9ba4b0ca582f-1580x870.png/image.png)
描述
在此栏中可撰写对组件进行说明的内容。
变量
如果变量的可覆写选项被勾选,则组件说明会自动为该变量生成相应的说明条目,变量的类型和初始值也会一并显示出来。
![[object Object]](https://cdn.sanity.io/images/vidqzkll/production/5081d7b157ecc59ccb48d17985e578103fef3c58-1580x870.png/image.png)
消息发出
在发送反应动作中选择发送到主控组件或发送到当前场景作为通道时,组件说明会自动生成相应的说明条目,所使用的消息和通道信息也会一并显示出来。
![[object Object]](https://cdn.sanity.io/images/vidqzkll/production/94a3d31ac356ed5d93ce12ab4cb9b2a0b9b0a2bc-1580x870.png/image.png)
消息传入
在接收触发动作中选择从主控接收或从当前场景接收作为通道时,组件说明会自动生成相应的说明条目,所使用的消息和通道信息也会一并显示出来。
![[object Object]](https://cdn.sanity.io/images/vidqzkll/production/77401f4d52ebf406f4649659872eb36a348c925e-1580x870.png/image.png)
预览
在子版组件的属性面板上点击组件说明图标可以预览所撰写的组件说明内容。
![[object Object]](https://cdn.sanity.io/images/vidqzkll/production/5b6ef4ad633996df6a9cb0b76a9173e422849ca4-1580x870.png/image.png)
缩小视图
点击右上方的缩小视图按钮可将组件说明以较小的呈现幅面固定于右上方。
![[object Object]](https://cdn.sanity.io/images/vidqzkll/production/38bf5f6b65bf440b1810b32fa3186ea6386ad268-1580x870.png/image.png)