组件添加描述链接
说明文档可以帮助团队成员了解设计系统的信息和背景，指导成员正确使用组件、组件集和可变状态，确保跨角色协作统一规范与信息透明。
说明文档不仅适用于设计团队，还包括产品经理、开发人员等所有需要调用组件的成员。
目前有几种为组件添加说明的方式：
-
为组件、组件集、可变组件赋予有意义的名称
-
为组件、组件集、可变组件添加组件描述
-
将文档链接添加到组件
为组件添加描述与链接
权限要求
需具备团队库文件的编辑权限
适用范围
支持为以下对象添加描述与链接：
-
组件
-
组件集
-
可变组件
操作步骤
-
打开团队库文件，选择组件、组件集或可变组件。
-
在右侧属性栏组件属性区域，「输入描述」处填写组件描述。
-
在右侧属性栏组件属性区域，「文档链接」处添加组件文档或资源链接。
查看组件描述和文档
添加了描述和文档以后，可以在以下对象中进行查看：
-
组件
-
组件集
-
可变组件
-
实例
如何查看组件的描述与文档：
1、在右侧边栏的实例菜单中可进行查看
- 组件描述会直接显示在属性栏中组件名称的下方。
- 点击「更多选项」图标，选择「查看文档」，可跳转文档链接。
2、在左侧资源面板中查看
- 打开左侧资源面板，将鼠标悬停在组件上，即可查看组件的名称及描述。
3、在右侧边栏的样式中查看
- 点击右侧边栏的「创建或使用样式」按钮，将鼠标悬停在组件上，即可查看样式的名称及描述。
4、在研发模式中查看
- 进入研发模式，选中组件，即可在检查面板中查看组件的描述与文档。
5、在标注面板中查看（仅限查看权限）
若对文件没有编辑权限，可在标注面板中查看组件的描述与文档。
注意： 若可变组件和组件集均包含文档链接，实例将仅展示可变组件的文档。
评价此篇文章：👍🏻 有帮助 👎🏻 无帮助
👉本篇文章对你是否有帮助？👍🏻 有帮助 👎🏻 无帮助，我们期待着你的反馈。