Ruby 注释

Ruby 注释

在学习注释如何在Ruby中应用之前？让我们了解编程中注释的确切含义以及使其变得如此重要的原因。

注释的主要目的是使源代码更易于程序员或开发人员理解。它们是该程序的一种文档，旨在提醒读者有关在编写源代码的过程中应用的棘手逻辑的信息。它们通常不由编译器或解释器处理。它们不是用编程语言输入的；首选人类友好的语言进行评论输入。

注释条目后面列出了各种目的：

• 容纳元数据：注释容纳源代码的元数据。它说明原始和版本，开发人员的名称，当前所有者等。

• 充当代码描述符：程序员使用代码描述来使读者理解她的逻辑。它告诉代码摘要。

• 帮助调试：在调试代码块时，它提供了很大的帮助。我们使用打印语句来查看特定块或模块的输出是什么，这样我们就不必在程序中遇到逻辑错误。对于程序员来说，找到逻辑问题发生的位置变得非常忙碌。成功调试之后，我们将打印语句作为注释条目。

• 有助于修改：通过使开发人员知道编码器应在其中进行更改以实现当前或所需目标的模块，可以在将来对代码进行修改。

Ruby中的注释

写评论被认为是一种好习惯。如果您暂时不想禁用代码，因为它们不会被解释或编译，则注释也很有用。在编写Ruby代码时，需要两种注释：

1. 单行注释

2. 多行注释

1）单行注释

您可以在代码行或内联代码的末尾使用单行注释，以使读者更容易理解该行。请记住有关单行注释的以下两点：

1. 它们以＃符号开头。它被称为英镑符号。

2. 作为一种好习惯，我们在注释的开始（＃）和元素之间放置空格。

语法：

    # (elements of the comment)

示例

puts "Enter Roll No"
#local variable 'roll'
roll = gets.chomp 

puts "Enter Name"
name = gets.chomp

puts "Enter percentage"

#conversion of string into integer
per = gets.chomp 		

if (per.to_i > 40)
	puts "Congratulations #{name} Roll no #{roll}! Your percentage exceeds passing criteria"
else
	puts "Hi #{name} Roll no #{roll}.You are fired!"
end

输出结果

Enter Roll No
101
Enter Name
Hritik
Enter percentage
88
Congratulations Hritik Roll no 101! Your percentage exceeds passing criteria

在上面的示例中，您可以看到我们有两个注释条目，即“局部变量'roll'（讲述变量）和“将字符串转换为整数”（通过.to_i方法）。

2）多行注释

多行注释也称为块注释。您可以通过编写多个井号＃来进行多行注释，如下所示：

    # (first line of the comment)
    # (second line of the comment)
    # (third line of the comment)

示例

    #puts "Hello World!"
    #puts "Cow gives us milk."
    #puts "Satyam is a crazy guy."

您还可以使用= begin ... = end选择并注释所有内容。但是只有现代的代码编辑器才允许使用此功能。

语法：

    =begin
    comment entry 1
    comment entry 2
    comment entry 3
    =end

示例

roll = gets.chomp                          
puts "Enter Name"
name = gets.chomp
puts "Enter percentage"
per = gets.chomp 	

=begin					
if (per.to_i > 40)
	puts "Congratulations #{name} Roll no #{roll}! Your percentage exceeds passing criteria"
else
	puts "Hi #{name} Roll no #{roll}.You are fired!"
end
=end

puts "You are caught!"

输出结果

Enter Roll No
101
Enter Name
Hritik
Enter percentage
88
You are caught!

在上面的示例中，if ... end块未编译，并且最后一条语句作为输出打印。