`
wangdeshui
  • 浏览: 255726 次
  • 性别: Icon_minigender_1
  • 来自: 北京
社区版块
存档分类
最新评论

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

Ruby正则表达式 
阅读更多

本文内容

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

一、单行注释

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

二、多行注释

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

image

三、特殊处理

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

image

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

/#This is regular express/

四、文档注释

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

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

image

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

image

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

image

image

本文作者： 王德水

未经本人同意，禁止转载

分享到：
| 一步一步学Ruby(二):变量,常量
评论
发表评论

您还没有登录,请您登录后再发表评论

相关推荐

    .一步一步学RUBY

    - **交互式环境**：Ruby提供了一个名为**IRB**（Interactive Ruby）的交互式环境，只需在命令行中输入`irb`即可启动，便于实验Ruby代码。 ##### Ruby的核心概念： - **一切皆对象**：在Ruby中，从基本数据类型到...

    Ruby on Rails Guides v2 - Ruby on Rails 4.2.5

    ### Ruby on Rails Guides v2 - Ruby on Rails 4.2.5 #### 一、重要概念及基础假设 - **重要概念**：本指南旨在帮助读者深入理解Ruby on Rails（以下简称Rails）4.2.5版本的核心功能与最佳实践。 - **基础假设**：...

    Ruby-在代码中编写TODO以确保您能够实际执行它们

    在Ruby代码中，`TODO`通常以这样的形式出现： ```ruby # TODO: 描述你需要完成的任务 ``` 这行注释告诉其他阅读代码的人（包括未来的你）这个特定的代码段目前不完善，需要在未来某个时间进行修改或扩展。然而，...

    Ruby语言入门教程v1.0

    第三章是对Ruby语法结构的全面概览，涵盖了注释、分隔符、关键字、运算符等基础元素，以及变量作用域、类库、数据类型等核心概念。其中，条件判断语句和循环语句的讲解特别重要，它们是构建逻辑流程的基础。此外，...

    Ruby语言入门教程

    - **注释**：Ruby中的注释可以使用`#`符号表示单行注释，或者使用`=begin`和`=end`来表示多行注释。 - **分隔符**：Ruby使用空格或换行作为元素之间的分隔符，而不是常见的逗号或分号。 - **关键字**：Ruby有许多...

    chart_demo.zip

    8. **文档和注释**：理解良好的代码注释和文档的重要性，以及如何编写它们。 通过解压和探索"chart_demo.zip"，用户不仅可以学习到如何在Ruby中制作图表，还能深化对Ruby语言的理解，并获得数据可视化的基本技巧。...

    Chess:用Ruby编写的针对两个玩家或一个玩家针对简单AI命令行的国际象棋游戏

    良好的代码结构和注释对于理解和维护代码至关重要，这也是Ruby社区所提倡的编程实践。 总的来说，这个项目提供了一个学习和实践Ruby编程、游戏逻辑设计以及基本AI策略的好机会。通过参与这个项目，开发者不仅能加深...

    在線翻譯代碼，賊好用！.

    2. **代码注释翻译**：它们不仅翻译代码本身，还可以处理代码中的注释，使得开发者能理解不同语言的注释内容。 3. **代码风格调整**：某些工具还会根据目标语言的习惯调整代码格式，例如缩进、括号使用等。 4. **...

    matlab集成c代码-next-step:下一步

    Matlab集成的c代码电脑语言 解释性编程语言 直接遵循语法而不进行编译。 Python （进行中） JavaScript （进行中） 功能编程语言 专注于功能的应用。 目前没有 编译程序语言 实现是编译器，而不是解释器。 C （想...

    sakura_quine:樱花奎奴

    这通常涉及到使用`eval`函数，它会解析并执行一个字符串中的Ruby代码。但需要注意的是，`eval`应谨慎使用，因为它可能会带来安全风险，因为它可以执行任意代码。 6. **完整的樱花奎因示例** 以下是一个简单的Ruby...

    tic-tac-toe

    在编写代码时，良好的编程实践也很重要，比如使用有意义的变量名，编写注释，以及遵循一定的代码结构。Ruby提倡DRY（Don't Repeat Yourself）原则，所以我们要避免重复的代码，尽可能地抽象出通用的函数。 最后，...

    sample_app:Michael Hartl 的 Rails 教程第 3 版中的“sample_app”

    在这个过程中，Hartl提供了详尽的代码注释，使得初学者能清晰理解每一步的目的和实现方式。 首先，让我们关注Rails的MVC架构。Model代表数据模型，通常与数据库交互，处理业务逻辑；View负责展示数据，提供用户界面...

    JAVA上百实例源码以及开源项目源代码

    Java绘制图片火焰效果 1个目标文件 摘要:Java源码,图形操作,火焰效果 Java绘制图片火焰效果，源代码相关注释：前景和背景Image对象、Applet和绘制火焰的效果的Image对象、Applet和绘制火焰的效果的Graphics对象、...

    Sass全面解析.pdf

    安装过程中，可以选择是否将Ruby和Sass的安装路径添加到系统环境变量中，这一步是关键，因为它决定了是否能够在命令行中直接使用Sass命令。 Sass的基本语法包括以下几个方面： 1. 使用变量来存储信息，这些变量可以...

    20150726-Linux系统及程序设计实验全部代码+4种动态网页语言完成综合性实验+2000字综合性实验报告详细

    题目名称 linux实验-基本指令1 题目关键字 linux实验-基本指令1 题目录入时间 2013-4-1 22:36:02 ...（3）第三种动态语言 以下同。 2、实验总结（有对比有分析有感想） 题目创建人 题目注释

    新入行程序员应知的十个秘密

    - **关键点：** 注重文档编写和代码注释。 - **详细解释：** Mariya Yao强调了编写良好文档和注释的重要性。对于团队项目而言，清晰的文档和充分的注释可以极大地提高代码的可读性和可维护性。这不仅有利于其他...

    Vim使用指南

    - **批量注释**：使用`ctrl+v`选中多行，然后按`shift+i`在光标所在行添加注释符号，最后按`ESC`键应用到选中的所有行。 - **前后移动**：使用`w`移到下一个单词，使用`e`移到单词尾，使用`b`移到前一个单词。 - **...

    fm-vagrant:PHP应用程序的Funnymonkey Puppet和Vagrant配置

    快速开始抓取此代码，用项目名称替换PROJECTNAME，请注意，如果您加载VirtualBox GUI，这也将是您的实例的主机名和VirtualBox图像的名称（注意：PROJECTNAME应该只包含字母，数字，连字符或点（不能以连字符或点开头...

    Education:jeckyll 教育网站

    **教育网站：使用Jekyll构建登录页面** Jekyll 是一个静态站点生成器，它将文本模板转换为静态网站，特别适合个人博客、教育...记住，良好的文档和注释也是项目成功的关键，它们能帮助其他开发者理解和贡献你的代码。

Magicbox
Global site tag (gtag.js) - Google Analytics