评论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's Blog上发现了类似的内容，其中新的ECMA 5标准使用未分配的字符串文字来启用“严格模式”。现在，我有兴趣进行评估，如果在进行此类文档时可能存在使用或危险。

Answer 1

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

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

Answer 2

我一直在寻找一种方法，可以在我的代码中添加多行字符串，而不会乱丢它。\ n＆＃39; s。看起来这个模块符合要求： https://github.com/monolithed/doc

不幸的是，这些评论在缩小后仍然存在，但我想你可以编写一个编译任务来将文档字符串转换为＆＃34; \ n＆＃34;格式。