介绍
@bochen/vue-prop-doc 是一个基于 Vue 的组件，用于自动生成 Vue 组件的属性文档。利用该工具，可以方便地查看和理解组件属性的含义和使用方法。
安装
使用 npm 进行安装：
--- ------- ---------- --------------------
使用
在组件中引入 @bochen/vue-prop-doc：
------ --- ---- ------ ------ ------- ---- ----------------------- -----------------
在你的组件中，加入注释，注释的格式如下：
--- - --- - ----- ------ -------- - ---- - ----- ------ ------------- - --------- --
例如：
--- - --- - ----- -------- ------- - ---- - ----- --------- ---------------- - ------- --
然后，在你的组件下添加 prop-doc 标签，建立与你的注释对应的属性文档：
----------
-----
-------------
---------------------
-------------
------
-----------最后，在使用的地方，可以非常方便地查看组件的属性文档：
------------- -------------- ------- --------------------------------
示例
----------
-----
------------
---------------------
---- ----------- -- ----- ------------------
------ ------------ ------------------- ------------------ --
-- ---------- --
------
------
-----------
--------
------ ------- -
----- ----------
------ -
---
- ----
--
------ -
----- -------- --------
--------- ----
--
---
- ----
--
--------- -
----- --------
-------- -----
--
---
- ----
- ----- -------- ----- - -------
- ----- --------------- ----- - ----
--
-------- -
----- ------
-------- -- -- --
-
--
------ -
------ -
--------- ----------
--
--
------ -
--------------- -
------------------- -------
--
--------------- -
------------- - ---------
-
--
--------- -
------ -
------ --------------------- -- --
------ -----------
------ ---------------------------- - ---------- - ----
----
-
-
--
---------上面的示例代码定义了一个单选框组件 MyRadio，并利用 @bochen/vue-prop-doc 自动生成了属性文档。通过属性文档，可以用很少的时间了解该组件的各种属性。在使用时，直接绑定组件的对应属性就可以了。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/600672693660cf7123b366c8