如何在jsDoc的名称/事件/回调中包含一个点？

Question

documentation for namepaths表示你应该转义特殊字符：

  

上面是一个名称空间中带有“异常”字符的示例   成员名称（哈希字符，破折号，偶数引号）。参考   这些你只需要引用名称：chat。“＃channel”，   聊天。“＃channel”。“op：announce-motd”，等等。内部报价   应使用反斜杠转义名称：   聊天 “＃信道”， “说 - \”。你好\ “”

然而，这对点不起作用。如果我想要记录一个名为“cellClick.dt”的事件，jsDoc将从输出中跳过文档，并在目录中生成错误的链接。我尝试了以下组合：

myClass~event.namespace
'myClass~event.namespace'
myClass~event\.namespace
myclass~'event.namespace'

所有这些都以某种方式生成破碎的文档。最后一个似乎至少可以生成正确的链接和文档，但是撇号仍然在输出中。这使得记录在事件中使用点用于命名空间分隔符的代码非常麻烦（例如，默认情况下为jQuery插件）。

这样做的正确方法是什么？有吗？我使用的版本是3.3.0-alpha9。

Answer 1

我建议这样做：

/**
 * @class
 */
function myClass () {
}

/**
 * @memberof myClass
 * @event event.namespace
 */

该事件已正确命名，并且是myClass的成员。令人讨厌的是必须将全名分成两部分，但至少结果并不难看。