【问题标题】:How to hide the "type" element如何隐藏“类型”元素
【发布时间】:2021-01-18 18:03:35
【问题描述】:

我发现“类型”部分复制了变量名之后已经显示的内容。有没有办法隐藏“类型”部分?

【问题讨论】:

    标签: javascript ide jsdoc


    【解决方案1】:

    假设您询问的是@param 标签。

    @param 标签提供函数参数的名称、类型和描述。
    @param 标记要求您指定要记录的参数的名称。您还可以包括参数的类型,用大括号括起来,以及参数的描述。

    根据文档,此声明的唯一强制性部分是参数的名称。如果您不想指定参数的类型,则可以这样做(但是您无法从 IDE 自动完成中受益,请注意,描述部分仅供人类使用)。
    如果您有一个给定的代码,它使用带有类型和描述的 JSDoc,那么您选择的 IDE 的工作就是显示什么和不显示什么。不过,我不相信有一个 IDE 不会显示类型,如果给定的话,或者它会以这种方式定制。

    如果你有类似的东西

    @param {string} name - string
    

    那么不是类型定义是额外的,而是描述是不相关/愚蠢的。

    【讨论】:

    • 谢谢!似乎只需将变量的类型添加到描述本身就是要走的路,因为所有数据都将从外部来源接收,并且类型检查在 vanilla js 中不起作用。
    猜你喜欢
    • 1970-01-01
    • 2016-11-08
    • 2016-06-19
    • 1970-01-01
    • 1970-01-01
    • 2014-05-10
    • 2011-02-13
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多