组件文档

什么是组件文档？

组件文档其实就是对当前组件的信息、属性等概要说明，以及如何使用组件等等信息的帮助手册。在IDM框架中，内置了加载对应位置的编写的组件文档，点击属性的帮助标识就能直接定位到对应的属性帮助文档上，从而实现在配置的时候有不明白的属性能直接快速查找文档。

文档目录

IDM对文档目录有一定的要求，虽然能自由规定文档目录，但是需要对所有组件的文档目录进行统一并且把文档目录配置到系统配置项中才能正常使用IDM的属性帮助。

提示

详细的目录配置信息可参考：文档管理

文档规范

1. 文档有统一的模板，在模板中建议属性使用内置目录标签@[compositeAttrToc]、@[innerAttrDataToc]作为组件属性的介绍

2. 文档维护建议使用文档管理在线维护然后下载到组件的开发环境代码包中

3. 一个组件包只有一个组件包文档，一个组件只有对应一个组件文档，组件包文档命名为index.md，组件的文档命名为组件类名.md

文档生成

对于还没有文档的组件（如果文档已存在，会提示是否覆盖原文档），可以使用idm-cli快速生成文档，

注意

使用前请确保安装idm-cli最新版 npm i @idm-modules/cli@latest -g

使用步骤

1. 查看idm-cli版本 npm info @idm-modules/cli 版本大于等于 1.0.36

2. 在idm组件项目中输入命令 idm doc <componentClassName>