javascript - 注释 JavaScript 函数 á la Python Docstrings

Question

编写如下内容是有效的 JavaScript：

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

字符串实际上什么都不做。有什么理由，为什么不应该以这种方式在 JavaScript 中评论他/她的函数？

在写这个问题时我能想到两点：

还有其他要点吗？

编辑：为什么我提出这个话题：我在John Resig 的博客上发现了类似的东西，其中新的 ECMA 5 标准使用未分配的字符串文字来启用“严格模式”。现在，我有兴趣评估做此类文档是否有用途或危险。

score 15 · Accepted Answer

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

如果您在 Javascript 中创建这样的字符串，则与使用注释相比没有任何好处，而且您会遇到一些缺点，例如字符串始终存在。

score 1 · Accepted Answer

我正在寻找一种将多行字符串添加到我的代码而不用 \n 乱扔它的方法。看起来这个模块符合要求： https : //github.com/monolithed/doc

不幸的是，注释无法在缩小后保留，但我想您可以编写一个编译任务将文档字符串转换为“\n”格式。

2 回答 2