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

Question

documentation for namepaths说你应该转义特殊字符:

Above is an example of a namespace with "unusual" characters in its member names (the hash character, dashes, even quotes). To refer to these you just need quote the names: chat."#channel", chat."#channel"."op:announce-motd", and so on. Internal quotes in names should be escaped with backslashes: chat."#channel"."say-\"hello\""

但是，这不适用于点。如果我想要记录一个名为“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 的成员.不得不将全名分成两部分很烦人，但至少结果并不难看。