The 名称路径的文档 http://usejsdoc.org/about-namepaths.html说你应该转义特殊字符:
上面是一个名称空间的示例,其中包含“不寻常”的字符
成员名称(哈希字符、破折号,甚至引号)。可供参考
您只需引用这些名称:chat."#channel",
聊天。“#channel”。“op:announce-motd”,等等。内部报价
名称应该用反斜杠转义:
聊天。"#channel"."说-\"你好\""
但是,这不适用于点。如果我想要记录一个名为“cellClick.dt”的事件,jsDoc 会跳过输出中的文档,并在目录中生成不正确的链接。我尝试过以下组合:
myClass~event.namespace
'myClass~event.namespace'
myClass~event\.namespace
myclass~'event.namespace'
它们都以某种方式生成损坏的文档。最后一个至少似乎生成了正确的链接和文档,但撇号仍然出现在输出中。这使得记录在事件中使用点作为命名空间分隔符的代码变得非常麻烦(例如 jQuery 插件默认情况下)。
这样做的正确方法是什么?有吗?我使用的版本是3.3.0-alpha9。
我建议这样做:
/**
* @class
*/
function myClass () {
}
/**
* @memberof myClass
* @event event.namespace
*/
该事件已正确命名并且是以下组织的成员myClass
。将全名分成两部分很烦人,但至少结果并不难看。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)