2.4 注释

Lua程序有两类注释：单行注释（--）和多行注释（--[[...--]]），这些注释方法与C、C++和Java都是完全不同。

1．单行注释

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

      if x > 1 then
          --注释 1
      else
          return false --注释 2
      end
      --if x > 1 then
      --else
      --    return false
      --end

2．块注释

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

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

      --[[
      if x > 1{
      }else{
          return false；
      }
      --]]

Lua多行注释有一个其他语言不具备的优点——可以嵌套，上述示例的最后一种情况是实现了多行注释嵌套。

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