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

本文内容

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

一、单行注释

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

二、多行注释

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

三、特殊处理

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

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

/#This is regular express/

四、文档注释

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

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

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

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

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

王德水

一步一步学Ruby(三): Ruby代码注释相关推荐

java的三种代码注释方式
1.注释的作用注释是对程序语言的说明,有助于开发者之间的交流,方便理解和维护程序.注释不是编程语句,不会被编译器执行.一些代码量少较少的程序,我们加不加注释对我们的理解和修改代码没有太大影响:如果是 ...
visual studio学习python_一步一步学Python3(小学生也适用) 第三篇: Visual Studio Code
工欲善其事,必先利其器: 器欲尽其用,必先得其法. 前面两章我们分别安装了Python3.8和在三种模式下运行了Python的print()函数程序.在开始我们正式学习Python基础语法时,我们先把 ...
（三）、一步一步学GTK+之布局
本来想接上篇把关于窗口方面的写的更详尽一点,但因为我做软件的习惯来说还暂时用不不到.我们先跳过,然后先说说窗口中的布局.跟大多数软件界面一样,一般包含标题栏.菜单栏.工具栏.状态栏和工作区等. 首先, ...
一步一步学VBScript(4)之WSH对象三
一步一步学VBScript(4)之WSH对象三前沿: 脚本可以干什么,它仅仅只是帮助您完成一个事件吗. 我觉得脚本是种生活.它帮你改变繁琐的重复劳动. 您可以让服务器管理着您的工作的.悠闲的品尝杯咖 ...
一步一步学Spring Boot（三）
课程名称 <一步一步学Spring Boot(三)> 学习地址 CSDN学习地址: http://edu.csdn.net/lecturer/994 51CTO学习地址:http://ed ...
零基础无实物一步一步学PLCS7-1200仿真（三）-电动机正反转控制（互锁）
在学习完电动机的启保停控制后,我们今天来学习电气控制里面进阶的正反转控制,也就是大名鼎鼎的互锁电路.首先需要了解电动机可以实现电动机正反转的工作原理. 一.硬件电路用S7-1200 PLC控制一台三 ...
一步一步学Spring Boot（三）-黄文毅-专题视频课程
一步一步学Spring Boot(三)-1059人已学习课程介绍 Spring Boot是现在很热门的一个微服务框架,作为一名Java Web 开发工程师,是必须要掌握它的.本系列课 ...
【Linux】一步一步学Linux——VMware虚拟机三种网络模式详解(07)
00. 目录文章目录 00. 目录 01. 虚拟网络连接组件 02. 常见网络连接配置 03. 桥接模式 04. NAT 模式 05. 仅主机模式 06. 自定义模式 07. 附录参考博客: ht ...
一步一步学Silverlight 2系列（3）：界面布局
概述 Silverlight 2 Beta 1版本发布了,无论从Runtime还是Tools都给我们带来了很多的惊喜,如支持框架语言Visual Basic, Visual C#, IronRuby, ...

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

一步一步学Ruby(三): Ruby代码注释相关推荐

最新文章

热门文章