A comment in Ruby is a code that will not be executed with the code, so basically, during the execution Ruby sees a certain key once and considers the code as a comment before the code and its main advantage is, we can do that. Write some definitions for long codes and we can write a few descriptions for the variables and functions used inside the codes, In Ruby, we can write two types of comments, one for a single line (for defining variables) and the other for multiple lines (for defining the whole function). 

One line comments start and end with only one line, which means that once # starts with the next new line there will be no more comments. Also, a single-line comment is a comment that is usually used to define a variable or a constant, which means that these single-line comments are inserted anywhere in the current code. 

We can illustrate the following example in the following steps. 

We have defined a method add and description for the add function above the function which starts with the # sign.

Here we can also describe inside the function, we have defined the variables a and b inside the function. 

When Ruby found it at the beginning of the #command, she realized that it was a single-line comment and that this code block would not work. 

So basically with the help of #, we can start commenting from anywhere in the code section.

  #add is the funct ion thath will return some of the numbers passed to it.
def add(a, b)
#a and b are the value of two numbers for addition
returna+b
end
#calling the addition method
sum= add(3,4)
#printing the sum of the two numbers.
puts "The some of the numbers are #{sum}" 
  


We are multiplying the two numbers and the comment sections are explaining the important sections of the code. 
 

 We have defined a function called Multi and within this function we are performing some multiplication. 

Before starting the function we defined or wrote the comments section which explains the multi function. 

Inside the function we are again explaining the two variables a and b with a comment.

Finally we are explaining the call of multi function. 

 #multi is the function which returns the multiplications of the two numbers.
def multi(a, b)
#a and b are the value of two number for multiplication
return a*b
end
#calling the multi method
sum = multi(3,4)
#printing the multiplication of the two numbers passed to the multi function, it will return numeric(if inputs are numeric).
puts "The multiplication of the two numbers is #{sum}" 

A multi-line comment is a comment that can be written in multiple lines, it can be used to comment for multiple lines, multiple lines = start and = end. So what we write inside the = begin and = end blocks will only be considered as a comment section. Such comments should only be used to define the function above or below. 

Here in this example we are defining all the details of the given function in one place, we have defined everything about the input value of the function multi and we have been able to define the function multi within the same comment block without using a single unit. Single line of comment for each section. 


puts The multiplication of the two numbers is #{sum}" 

In the example below again we were able to explain everything in a comment section, we wrote the description about the function and it used the variables as well as the objectives of the given function. Once Ruby finds the start of the = begin command, it will only consider everything before the end as a non-executable code (comment). 

=begin
add is the function which will return some of the numbers passed to it
#a and b are the value of two number for addition
we can call add function function to do addition and it will return integer value if the input a and b are the integer.
=end
def add(a, b)
returna+b
end
sum = add(3,4)
puts "the some of the numbers are #{sum}"

From this tutorial we learned about Ruby comments and their types, we learned about the function and structure of both types of comments which are single line comments and multiple line comments, we learned the situations where we should use single line comments. And where we should use multiline comments.
 

Ruby comments are non-executable lines in a program. These lines are ignored by the interpreter so they do not work when running a program.

How To Use Comments in Ruby

Can I use comments inside a JSON file? If so, how? 

comments

Trending Blogposts on comments

How To Use Comments in Ruby

Popular Discussions on comments

openCan comments be used in JSON?

1

0

0

PRODUCTS

QUICK LINKS

LEGAL

comments

Trending Blogposts on comments

How To Use Comments in Ruby

Popular Discussions on comments

openCan comments be used in JSON?

1

0

0