背景:
不同项目之间会有一些单独服务于当前项目的业务组件,不同于公共组件有专门的文档说明、用法示例等,此时想快速了解当前项目中业务组件的应用场景,判断是否符合当下的开发任务需求,似乎只有拿着设计稿去问小组内的其他人才能快速的得到答案。为了能快速了解业务组件,采用md + 配图的方式来快速预览当前业务组件的快照。
方案:
- 在当前组件下创建专用的文件夹Diagrammatize,然后创建READ.md文件
- 安装vs-code插件:Paste Image
- 用法:使用任意方式的选择图片(截图、复制图片等),然后command + option + v进行粘贴图片到md文件)
例如: