Lua注释

Lua注释教程

用于注解说明解释程序的文字就是注释，注释提高了代码的阅读性。同时，注释也是一个程序员必须要具有的良好编程习惯。我们应该首先将自己的思想通过注释先整理出来，再用代码去体现。

在 Lua 中，一旦程序中某部分内容被注释掉，则该内容将会被 Lua 解释器忽略，换句话说，此部分内容将不会被执行。Lua 提供了两种注释的形式，即行注释和块注释。

Lua注释作用

注释不仅可以用来解释程序某些部分的作用和功能（用自然语言描述代码的功能），在必要时，还可以将代码临时移除，是调试程序的好帮手。

通常而言，合理的代码注释应该占源代码的 1/3 左右。

行注释

定义

Lua 的行注释用于注释一行代码，且可以嵌套使用。

语法

-- 注释内容

说明

我们使用了 -- 注释了一行代码。

块注释(多行注释)

定义

Lua 的块注释用于注释多行代码，同时，也可以注释一行代码。

语法

--[[ 
注释内容
注释内容
注释内容
注释内容
--]]

说明

所有写在 --[[ 与 --]] 之间的都是多行注释。

案例

Lua行注释

Lua 行注释只能用来注释单行代码

#!/usr/bin/lua
-- print("嗨客网")
print("Hello HaiCoder(www.haicoder.net)")
--print("嗨客网手机端")

程序运行，控制台输出，如下图：

我们可以看到，程序只输出了中间一行，并没有输出第一行和最后一行，这是因为第一行和最后一行都被注释了。

Lua块注释

Lua 块注释可以用来一次注释多行代码

#!/usr/bin/lua
--[[ 
print("嗨客网 Java 模块")
print("嗨客网 Python 模块")
print("嗨客网 Golang 模块")
--]]
print("Hello haicoder(www.haicoder.net)")

程序运行，控制台输出，如下图：

我们可以看到，所有写在 --[[ 和 --]] 之间的代码都未被执行，因为被批量注释了。

Lua注释总结

Lua 注释分为单行注释和块注释。