在javascript对象文字中添加注释

时间:2015-05-25 13:09:15

标签: javascript object-literal

是否可以在javascript对象文字中添加注释? 以下示例适用于Firefox,但我找不到任何明确的文档。此外,我看到的所有示例似乎都避免了对象文字中的注释。

  var o = {
    p1: 2,                 // a comment about p1

    /* A comment about function f1 */
    f1: function() { 
      return 3;  
    }
  };

2 个答案:

答案 0 :(得分:5)

注释几乎可以放在JavaScript中的任何位置 - 解析器会忽略它们。有关评论的详细信息,请参阅MDN

一些例子......

function test (/* comment where arguments are usually listed */) {}
var obj = /* comment after assignment operator? Why not */ {}
var obj = { prop/* possible, but please don't do this */: 'val' }

请注意,上面的示例并不是一个好的做法 - 我在此处将它们包含在内只是为了表明可以在JavaScript代码中的几乎任何位置放置注释。

  

经验法则是:如果删除所有注释并且结果是有效的JavaScript,那么您可以在那里发表评论。

区分JavaScript和JSON也很重要 - 虽然JSON名称中有 JavaScript ,但它与JavaScript语法无关。并且不允许使用JSON中的注释。

答案 1 :(得分:2)

是的,你可以。没有理由不这样做。虽然JSON不允许这样做,但不要在JS和JSON之间混淆。