一步一步学Ruby(三): Ruby代码注释

本文内容

• 单行注释
• 多行注释
• 特殊处理
• 文档注释

一、单行注释

#开头，以# 开头直到本行末尾的内容都被当作注释

二、多行注释

=begin 注释文字 =end, 注释关键字和注释的文本至少要一个空格的距离

三、特殊处理

a. 字符串类的#不会当作注释

b. 正则表达式内的#不会被当作注释

/#This is regular express/

四、文档注释

文档注释，这里指可以根据代码中的注释生成漂亮的文档

我们按如下的格式，一级标题用=,二级标题用==,以此类推

使用rdoc命令，可以很用以生成漂亮的注释文档

默认生成到代码文件所在位置。

本文作者： 王德水

未经本人同意，禁止转载