📜  ruby 注释 - Ruby (1)

📅  最后修改于: 2023-12-03 15:34:46.079000             🧑  作者: Mango

Ruby 注释 - Ruby

在 Ruby 中,注释是一种将代码标记为不应被执行的方法。它们通常用于记录代码、解释代码、提供文档或禁用代码等情况。

单行注释

在 Ruby 中,单行注释以 # 符号开始。任何跟在 # 符号后面的文本都将被视为注释。

# 这是一个单行注释

puts "Hello, World!" # 这是另一个单行注释
多行注释

Ruby 没有官方支持的多行注释语法,但您可以使用以下语法来实现:

=begin
这是一个多行注释.
这是第一行。
这是第二行。
=end

puts "Hello, World!"

需要注意的是,= 符号必须在行首,并且注释必须以 =end 结束。多行注释通常用于注释多行代码或长段落。

文档注释

文档注释是一种特殊的注释,用于创建代码文档。文档注释通常以 # 符号和两个 ! 符号开始。

#!/usr/bin/env ruby

=begin
这是一个简单的 Ruby 脚本,用于打印欢迎消息。

用法:

$ ruby hello.rb
=end

puts "欢迎使用 Ruby"
总结

注释是编写清晰、易于维护代码的重要组成部分。在 Ruby 中,单行注释以 # 开始,在行尾结束。多行注释可以使用 =begin=end 来实现。文档注释以两个 ! 符号开始。在编写代码时,请记得添加适当的注释。