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

简介:

本文内容

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

一、单行注释

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

二、多行注释

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

image

三、特殊处理

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

image

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

/#This is regular express/

四、文档注释

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

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

image

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

image

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

image

image

本文转自敏捷的水博客园博客,原文链接http://www.cnblogs.com/cnblogsfans/archive/2009/01/23/1380540.html如需转载请自行联系原作者


王德水

相关文章
|
10月前
|
算法 测试技术 API
如何用Ruby语言提高代码的可读性和可维护性
在软件开发过程中,代码的可读性和可维护性是非常重要的因素。一旦代码变得难以理解和修改,就会导致开发速度变慢、bug增多以及团队合作效率下降。在本篇博客中,我们将探讨一些使用Ruby编程语言的技巧和最佳实践,以提高代码的可读性和可维护性。
59 1
|
2月前
|
JSON 监控 数据可视化
局域网管理软件的Ruby代码实践
使用Ruby进行局域网管理的实践,包括安装`net-ping`库进行设备扫描、利用`packetgen`监控流量、执行文件备份自动化任务和数据可视化,以及通过HTTP提交数据。示例代码展示了Ruby在局域网管理中的灵活性和效率。
115 5
|
2月前
|
存储 JavaScript 编译器
这款国产中文编程火了!通过文言文编译生成Python、JS、Ruby代码!
这款国产中文编程火了!通过文言文编译生成Python、JS、Ruby代码!
|
2月前
|
Ruby
|
10月前
|
安全 JavaScript 程序员
Ruby 代码清洁之道 (翻译)
Ruby 代码清洁之道 (翻译)
|
10月前
|
Java Linux 应用服务中间件
在 Ruby on Rails 应用程序中重用 Java 代码
在 Ruby on Rails 应用程序中重用 Java 代码
Sorcerer 基于抽象语法树生成Ruby代码
Sorcerer是Jim Weirich开发的Ruby代码生成器,能够基于Ripper类的抽象语法树(例如S表达式)。
176 0
|
Java Ruby 容器
java调用ruby代码
问题: 最近在做一个应用的时候碰到了一个问题。客户端需要调用服务器端传回的脚本信息,然后执行。其中脚本类型包括ruby。而java中调用ruby的代码大致如下: 1 String jrubyCode="puts 'hello world'"; 2 ScriptEngineManager ...
1286 0