【问题标题】:How to handle dots in event names with @fires in jsdoc如何在jsdoc中使用@fires处理事件名称中的点
【发布时间】:2015-01-15 11:18:45
【问题描述】:

我有一个名为namespace.event 的事件。当我想使用标签@fires 时,这些点会导致 JsDoc 出现问题。当我这样做时:

/**
@fires MyClass#namespace.myevent
*/

我得到的结果是纯文本MyClass#namespace:event:myevent。有没有办法逃脱点? 我试过 namespace\.event 不起作用,'namespace.event' 保留点,但也用引号渲染。

有关信息,我在这里找到了标记 @event 的解决方法:How do you include a dot in names/events/callbacks with jsDoc?。但这不适用于@fires

【问题讨论】:

    标签: javascript doc jsdoc


    【解决方案1】:

    在最底部,它说用特殊字符引用名称。所以应该是MyClass#"namespace.myevent"

    http://usejsdoc.org/about-namepaths.html

    【讨论】:

    • 这里令人沮丧的是,我有一个带点的命名空间:ko.dt。当我用双引号括起来时,会显示 ko.dt 字符串,但它也会显示文字双引号。
    【解决方案2】:

    遇到同样的问题。对我有用的解决方案是使用点状字符(ONE DOT LEADER unicode:U+2024)。我从 char 概览窗口复制了它。

    对于 mac: 系统设置 -> 键盘 -> 在面板中显示概览

    【讨论】:

    • 恐怕这行不通。它只是显示一个文字 :U+2024
    猜你喜欢
    • 2014-12-16
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2015-09-15
    • 2011-07-24
    • 1970-01-01
    相关资源
    最近更新 更多