评论JavaScript函数是Python Docstrings

Question

写这样的东西是有效的JavaScript:

function example(x) {
    "Here is a short doc what I do.";
    // code of the function
}

字符串实际上什么也没做.有什么理由,为什么不应该以这种方式在JavaScript中评论他/她的功能？

在讨论问题时我能想到的两点:

• 必须启动字符串文字,从长远来看这可能是昂贵的

• JS minifiers不会将字符串文字识别为可移除的

还有其他一点吗？

编辑:为什么我提出这个主题:我在John Resig的博客上发现了类似的东西,其中新的ECMA 5标准使用未分配的字符串文字来启用"严格模式".现在,我有兴趣进行评估,如果在进行此类文档时可能存在使用或危险.

Answer 1

在Javascript中这样做真的没有意义.在Python中,字符串可用作__doc__函数,类或模块的成员.因此,这些文档字符串可用于内省等.

如果你在Javascript中创建这样的字符串,那么使用注释就没有任何好处,而且你会遇到一些缺点,比如字符串总是存在.