如何使用jsdoc中的@fires处理事件名称中的点

时间:2015-01-15 11:18:46

标签: javascript doc jsdoc

我有一个名为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

2 个答案:

答案 0 :(得分:2)

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

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

答案 1 :(得分:-1)

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

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