Ruby注释

Ruby注释教程

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

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

Ruby注释作用

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

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

行注释

定义

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

语法

# 注释内容

说明

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

块注释(多行注释)

定义

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

语法

=begin 
注释内容
注释内容
注释内容
注释内容
=end

说明

所有写在 =begin 与 =end 之间的都是多行注释。

案例

Ruby行注释

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

#!/usr/bin/ruby -w
# -*- coding : utf-8 -*-
puts "HaiCoder(www.haicoder.net)"
# puts "嗨客网"

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

我们可以看到，程序只输出了第一行，并没有输出第二行，这是因为第二行代码被注释了。

Ruby块注释

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

#!/usr/bin/ruby -w
# -*- coding : utf-8 -*-
puts "HaiCoder(www.haicoder.net)"
puts "嗨客网 Ruby 模块"
=begin
puts "嗨客网 Python 模块"
puts "嗨客网 C++ 模块"
puts "嗨客网 Golang 模块"
=end
puts "嗨客网 Shell 模块"

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

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

Ruby注释总结

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