DCloud_HB_WDL
DCloud_HB_WDL
  • 发布:2019-04-12 11:57
  • 更新:2020-09-17 17:58
  • 阅读:15136

HBuilderX: vue doc使用教程

分类:HBuilderX

重要:文档已迁移至 https://hx.dcloud.net.cn/Tutorial/Language/vuedoc

HBuilderX 1.9.0 新增了vue doc功能

什么是 vue doc ?

可以理解为,vue组件使用说明。

在其它文件,使用组件的时候,弹出代码提示。

什么是组件?组件是可复用的 Vue 实例,且带有一个名字。

语法

主要用在script部分,需要写在export default上面

/**  
* 这里是一个组件描述,会在提示标签的时候显示  
* @description 这里也是一个组件描述  
* @tutorial https://uniapp.dcloud.io/api/media/image?id=chooseimage  
* @property {String} type = [button|input|...值域] 这里是属性描述  
* @event {Function} tap 这是是事件描述   
* @example 这里是示例代码  
*/

其中@property和@event内{ }中间的是类型,event的类型必须是Function

示例

<script>  
  /**  
   * 翻页组件  
   * @description 翻页组件  
   * @tutorial http://www.baidu.com  
   * @property {Number} total 翻页数据总数  
   * @property {String} size = [big|small] 组件大小  
   * @event {Function} close 关闭事件  
   * @example <Pagination @total="50" @close=""></Pagination>  
   */  
  export default {  
    props: {  
      "total": Number,  
      "size": String  
    },  
    data () {  
      return {  
        pageSize: 10,  
        pageNumber: 0  
      }  
    },  
    methods: {  
      handleChange(data, event) {  
        this.$emit('PsPn', this.pageSize, this.pageNumber)  
      }  
    }  
  }  
</script>

组件提示,效果如下:

属性提示:

事件提示:

9 关注 分享
DCloud_UNI_HT Donny 4***@qq.com phpoks 3***@qq.com lcysgsg DCloud_heavensoft 5***@qq.com 1***@163.com

要回复文章请先登录注册

wenju

wenju

回复 4***@qq.com :
试试定义组件的 name
2020-09-17 17:58
wenju

wenju

知道了, 组件必须定义 name: 'xxx' 否则不生效..
2020-09-17 17:58
wenju

wenju

我发现 easycom 的 不生效呢... 必须要 import 进来才可以
2020-09-17 17:52
qmit

qmit

好,收藏了。
2020-09-08 10:36
紫洋

紫洋

可否实 现property 等用在具体字段上面做注释解析?不然还得一个一个加到表头中去
2020-07-31 09:31
4***@qq.com

4***@qq.com

如果不引入,或者vue全局引入,还能生效吗,我试了一下午一直无法生效
2020-05-13 19:15
libingchen

libingchen

@property {String} type = [button|input|...值域] 这里是属性描述
值域的描述应该怎么添加
2020-05-02 14:05
zxzz

zxzz

我修改过组件提示,在main.js中引用的,提示没有生效是什么原因
2020-01-06 10:50
1***@qq.com

1***@qq.com

回复 1***@qq.com :
发现问题了,同时在两个页面分别调用了两个相同的组件(一个为原组件,一个为复制出来查看源码修改学习的),两个页面调用时采用了相同的调用方式,仅仅调用地址不一致,复制出来的组件里写Vue doc,在对应的调用页面无法正确提示,把原组件的调用删掉就好了
2019-08-19 14:32
1***@qq.com

1***@qq.com

请问,如果是属性提示的属性名是系统关键字该如何呢,比如quality这个我就始终无法提示
2019-08-19 12:30