uni-app 【报Bug】vue doc @value中"xx-xx"格式的属性选项，注释说明无法正常显示

uni-app 【报Bug】vue doc @value中"xx-xx"格式的属性选项，注释说明无法正常显示

产品分类

HbuilderX

PC开发环境操作系统

Windows

PC开发环境操作系统版本号

3.99

HBuilderX版本号

3.99

示例代码：

/**
 * 动态布局组件
 * @description 动态布局组件  
 * @property {String} flexDirection = [row|row-reverse|column|column-reverse] 主轴的方向（子元素的横竖排列方向）  
 *  [@value](/user/value) row 水平方向，起点在左端。  
 *  [@value](/user/value) row-reverse 水平方向，起点在右端。  
 *  [@value](/user/value) column 垂直方向，起点在上沿。  
 *  [@value](/user/value) column-reverse `垂直方向，起点在下沿。`  
 * @property {String} flexWrap = [nowrap|wrap|wrap-reverse] 子元素过多(多行,一条轴线排不下)如何换行  
 * @property {String} justifyContent = [flex-start|flex-end|center|space-between|space-around] 子元素在主轴上对齐方式  
 * @property {String} alignItems = [flex-start|flex-end|center|baseline|stretch] 子元素在交叉轴的对齐方式  
 * @property {String} alignContent = [flex-start|flex-end|center|space-between|space-around|stretch] 子元素在多根轴线上的对齐方式  
 * @example <uni-flex flexDirection="row" justifyContent="center"><view>子元素1</view><view>子元素2</view></uni-flex>    
 */

操作步骤：

  1. easycom组件，定义一个组件，加添组件说明，组件代码中设置@value xx-xx value说明内容
  2. 调用该easycom组件

预期结果：

输入@value的对应属性名称，在属性选项中选择xx-xx， 应该对应有该value说明内容

实际结果：

说明内容为空

bug描述：

关于组件的注解 vue doc
在@value注解中，如果值是用"-"连接的情况下，注释说明失效。
详细请看截图


更多关于uni-app 【报Bug】vue doc @value中"xx-xx"格式的属性选项，注释说明无法正常显示的实战教程也可以访问 https://www.itying.com/category-93-b0.html

1 回复

更多关于uni-app 【报Bug】vue doc @value中"xx-xx"格式的属性选项，注释说明无法正常显示的实战教程也可以访问 https://www.itying.com/category-93-b0.html


在 uni-app 中使用 Vue 的 @value 注解时，如果属性选项中包含 xx-xx 这种带有连字符的格式，可能会导致注释说明无法正常显示。这是一个已知的问题，通常与解析器的处理方式有关。

问题原因

xx-xx 这种带有连字符的格式在 Vue 的 @value 注解中可能被解析器误认为是某种特殊语法，导致注释无法正常显示。

解决方案

你可以尝试以下几种方法来解决这个问题：

  1. 使用驼峰命名法
    将 xx-xx 改为驼峰命名法，例如 xxXx，这样解析器可以正确识别。

    /**
 * @value {String} xxXx - 这是一个示例属性
 */

  2. 使用引号包裹
    如果必须使用 xx-xx 这种格式，可以尝试用引号包裹属性名。

    /**
 * @value {String} 'xx-xx' - 这是一个示例属性
 */

  3. 使用其他注释格式
    如果以上方法无效，可以尝试使用其他注释格式，例如直接写在 @value 后面。

    /**
 * @value {String} xx-xx 这是一个示例属性
 */

  4. 检查 uni-app 版本
    确保你使用的是最新版本的 uni-app，因为某些问题可能在新版本中已经修复。

  5. 使用 @type 注解
    如果 @value 注解无法正常工作，可以尝试使用 @type 注解来代替。

    /**
 * @type {String} xx-xx - 这是一个示例属性
 */
回到顶部