Vue styleguidist相关

[buddywang]

Tags

@values

如果一个prop取值有限制，可以用它来说明

export default = {
    props: {
      /**
       * The size of the button
       * @values small, normal, large
       */
      size: {
        type: String,
        default: 'normal'
      }
    }
}

@deprecated

不推荐使用的prop，有删除线效果

/**
 * An example-less button.
 * @deprecated Use the [only true button component](#button) instead
 */

@ since

指定该属性/方法/类在特定版本新增的

export default = {
    props: {
      /**
       * The size of the button
       * @values small, normal, large
       * @since 1.0.1
       */
      size: {
        type: String,
        default: 'normal'
      }
    }
}

@ignore

忽略该prop，在文档上不显示

    props: {
      /**
       * The size of the button
       * @ignore
       */
      size: {
        type: String,
        default: 'normal'
      }
    }

修饰方法

• @param：参数说明 @param {string} somebody Somebody's name. （类型、名字、描述）
• @event：说明在文档上的事件名字 @event click （一个名为click的事件）
• @public：在文档上显示该方法