购买
下载掌阅APP,畅读海量书库
立即打开
畅读海量书库
扫码下载掌阅APP

2.4 注释

JavaScript程序有两类注释:单行注释(//)和多行注释(/*…*/),这些注释方法C、C++和Java都是类似的。

1. 单行注释

单行注释可以注释掉整行或者一行中的一部分。它一般不用于连续多行的注释文本,然而,它也可以用来注释掉连续多行的代码段。以下是几种风格注释的例子:

    if x > 1 {
      //注释1
    } else {
      return false;    //注释2
    }
    //if x > 1 {
    //                     //注释1
    //} else {
    //  return false;     //注释2
    //}

2.块注释

一般用于连续多行的注释文本,但它也可以对单行进行注释。以下是几种风格注释的例子:

  if x > 1 {
      /* 注释1 */
    } else {
      return false;   /* 注释2 */
    }
    
    /*
    if x > 1 {
      //注释1
    } else {
      return false;  //注释2
    }
    */
    
    /*
    if x > 1 {
      /* 注释1 */
    } else {
      return false;    /* 注释2 */
    }
    */

JavaScript多行注释有一个其他语言没有的优点,就是它们可以嵌套。上述实例的最后一种情况是实现了多行注释嵌套。

在程序代码中使用注释,对容易引起误解的代码进行注释是必要的,但应避免对已清晰表达信息代码进行注释。需要注意的是:频繁的注释有时反映出代码的低质量。当觉得被迫要加注释的时候,考虑一下重写代码使其更清晰。 TOwq/GkSahMqmPqd3cUCNXuocfA0bIssUV4JS/H2uGPuGFuShDN2UVQ1erA7BLTe

点击中间区域
呼出菜单
上一章
目录
下一章
×