1.1Ruby语言的注释(Comment)

huoxiaoqiang • 2022年12月1日 20:37 • Ruby语言教程 • 阅读 1281

1.单行注释

# 单行注释

多个 # 可以表示多行注释。

# 这是多行注释
# 这也是多行注释
# 这还是多行注释

多行注释以 =begin 开头和以 =end 结尾。

=begin 和 =end 后的内容都是注释，=begin 和注释之间至少有一个空格，=end 同之。

=begin 这是多行注释
这也是多行注释
这还是多行注释
=end 不要惊讶，这也是多行注释

多个 # 表示的多行注释可被 rdoc 工具当成文档注释处理。

# 这是多行注释
# 这也是多行注释
# 这还是多行注释

在多行注释的 =begin 开头后加上 rdoc 可被 rdoc 工具当成文档注释处理。

=begin rdoc
=end

shebang 注释的作用是指示类Unix操作系统如何执行该文件的。

shebang 注释必须在文件的第一行。

#!/usr/bin/ruby -w

# 指令1: 值1; 指令2: 值2; 指令N: 值N

单行注释 # 后面的内容通常会被 Ruby 解释器忽略，但包含指令的特殊“魔法注释”不会被忽略，会影响代码的解释方式，不过只影响它们出现的文件，其它文件不受影响。

指令和值不区分大小写。值必须不能包含空格，也不能包含除了连字符(-)和下划线(_)以外的标点符号。指令和值必须使用冒号(:)或等号(=)分隔。

魔法注释必须出现在文件的第一行，但当有shebang注释时，魔法注释就可以出现在第二行。

# 单个魔法注释
# encoding: GBK

# 多个魔法注释
# coding: big5; mode: ruby; frozen_string_literal: true

# Emacs文本编辑器兼容的方式
# -*- coding: big5; mode: ruby; frozen_string_literal: true -*-

# vi文本编辑器兼容的方式
# vi: set fileencoding=big5 :

原创文章，作者：huoxiaoqiang，如若转载，请注明出处：https://www.huoxiaoqiang.com/ruby/rubylang/1490.html