文档章节

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

ThinkGem
 ThinkGem
发布于 2016/07/17 16:09
字数 215
阅读 21
收藏 0

本文内容

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

一、单行注释

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

二、多行注释

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

image

三、特殊处理

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

image

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

/#This is regular express/

四、文档注释

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

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

image

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

image

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

image

image

本文作者: 王德水

本文转载自:http://yc75.iteye.com/blog/379918

ThinkGem

ThinkGem

粉丝 1268
博文 142
码字总数 31335
作品 2
济南
架构师
私信 提问
ruby的rvm安装使用微教程

操作系统 centos 6.2 安装rvm 说明下, 如果用root帐户操作, 默认会將 rvm 装到 /usr/local/rvm 下. 其它帐号则在 ~/ 目录下. 加载 rvm : 好了, 装ruby. 也可以用 列出可安装的 ruby 版本, 如...

大东哥
2012/05/17
9.5K
1
Sass入门介绍

CSS预处理器,用一种专门的语言进行页面Web样式设计,编译生成正常的CSS文件以供使用,可以让CSS更加简洁、适应性更强、可读性更佳、更易于代码的维护。 优秀的CSS预处理器语言包括Sass、LES...

刘尐六
2017/05/26
0
0
SASS入门-安装

xcode安装:可百度自行补脑安装,真的是很简单! 步骤1 - 安装homebrew 进入终端工具的命令行,输入如下的语句: 出现的结果和对应的解决方案 命令brew进行测试 补充小知识: 步骤2 - 安装 ...

大仁孙
2016/07/22
11
0
脱离Rails使用ActiveRecord

ActiveRecord是Ruby的对象-关系映射(ORM)框架,它几乎总是被视为Rails框架的一部分,但其自身也是一个实体,可通过gem单独安装和使用。本文以访问Sqlite3为例,介绍如何在Rails框架之外使用...

redraiment
2014/02/11
1K
2
教你通过Octopress一步一步搭建属于自己博客

需要用到的软件以及作用 1、Git:版本管理工具,将代码托管到GitHub 2、Ruby + DevKit:生成静态网页 3、MarkdownPad:Windows下Markdown语法编辑器 首先注册一个GitHub帐号 下载git安装包,...

liuzhenlife
2017/02/09
0
0

没有更多内容

加载失败,请刷新页面

加载更多

Java 中的 String 有没有长度限制

转载: https://juejin.im/post/5d53653f5188257315539f9a String是Java中很重要的一个数据类型,除了基本数据类型以外,String是被使用的最广泛的了,但是,关于String,其实还是有很多东西...

低至一折起
27分钟前
8
0
OpenStack 简介和几种安装方式总结

OpenStack :是一个由NASA和Rackspace合作研发并发起的,以Apache许可证授权的自由软件和开放源代码项目。项目目标是提供实施简单、可大规模扩展、丰富、标准统一的云计算管理平台。OpenSta...

小海bug
昨天
10
0
DDD(五)

1、引言 之前学习了解了DDD中实体这一概念,那么接下来需要了解的就是值对象、唯一标识。值对象,值就是数字1、2、3,字符串“1”,“2”,“3”,值时对象的特征,对象是一个事物的具体描述...

MrYuZixian
昨天
7
0
解决Mac下VSCode打开zsh乱码

1.乱码问题 iTerm2终端使用Zsh,并且配置Zsh主题,该主题主题需要安装字体来支持箭头效果,在iTerm2中设置这个字体,但是VSCode里这个箭头还是显示乱码。 iTerm2展示如下: VSCode展示如下: 2...

HelloDeveloper
昨天
9
0
常用物流快递单号查询接口种类及对接方法

目前快递查询接口有两种方式可以对接,一是和顺丰、圆通、中通、天天、韵达、德邦这些快递公司一一对接接口,二是和快递鸟这样第三方集成接口一次性对接多家常用快递。第一种耗费时间长,但是...

程序的小猿
昨天
11
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部