资讯频道 → 编程语言
阅读更多

0顶
0踩

编程语言

原创新闻 RDoc 3.10发布，Ruby的文档系统

2011-10-09 13:24 by 副主编 wangguo 评论(0) 有4534人浏览
rdoc ruby 文档系统

声明：ITeye资讯文章的版权属于ITeye网站所有，严禁任何网站转载本文，否则必将追究法律责任！

RDoc 3.10发布了！



RDoc是针对Ruby源代码的文档系统。跟JavaDoc一样，RDoc可以读取原文件，分析源代码中的语法信息和注释文本，生成HTML格式的文档。和JavaDoc不同的是，即便源代码没有任何注释，RDoc也能生成相当漂亮的文档内容。在编写源程序的同时编写RDoc可以说易如反掌。Ruby的内建库和标准库文档都是用RDoc生成的。应该可以使用ri命令来访问这些文档，不过这也取决于你安装Ruby的方式。

该版本增强了部分功能和修复了一些Bug，包括：

主要增强：

  • 改善了RDoc HTML输出。
  • 支持更多的文档格式：TomDoc 1.0.0 - RC1和Rd格式。
  • 现在可以保存和加载选项文件。
小幅改进：

  • HTML标题现在拥有和标题匹配的id，如“= Hello!”呈现为“<h1 id="label-Hello%21">Hello!</h1>”。
  • 类或方法的标签可以通过添加一个“@”来链接到此类或方法的相关内容。
  • 针对HTML输出，RDoc中SomeClass.method_name和SomeClass#method_name用于远程方法和属性，::method_name and#method_name用于本地方法。
  • 改进了Ruby代码的语法高亮。
  • 新增了rdoc-label链接机制，允许双向链接。
  • HTTPS URL中的图片路径现在能被转换成+<img>+ tags形式。
  • 新增了RDoc::Comment，可对评论进行处理。
另外，该版本还修复了一些Bug，详细信息参阅：RDoc发行说明

Rdoc文档：http://rdoc.rubyforge.org/

下载地址：https://github.com/rdoc/rdoc

  • 大小: 6.4 KB
0
顶
0
踩
评论 共 0 条 请登录后发表评论

发表评论

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

相关推荐

  • reids3.0安装文档

    安装文档 1.安装依赖 yum -y install gcc yum -y install gcc-c++ yum -y install ruby ...yum -y install ruby-rdoc yum -y install ruby-devel rubygems rpm-build gem install redis 2.部署方案 1. 安...

  • ruby入门示例1

    #“从#开始到行尾是单行注释” puts 3/5 puts 3/5.0 =begin puts 6/5 puts 6/5.0 多行注释可以用=begin 和 =end 实际上，这是Ruby的内嵌文档Rdoc，类似javadoc ， 可以用命令 ri 从源文件生产文档。 =end #演示分行 ...

  • 《Ruby语言入门教程v1.0》学习笔记-01

    《Ruby语言入门教程v1.0》 编著：张开川 邮箱：kaichuan_zhang@126.com 想要学习ruby是因为公司的自动化测试使用到了ruby语言，但是公司关于ruby只给了一个简单的ppt做讲解，可能是因为我们需要使用到的并不多...

  • puppet工作原理及部署redis主从篇

    　puppet是一种Linux、Unix、windows平台的集中配置管理系统，使用自有的puppet描述语言，可管理配置文件、用户、cron任务、软件包、系统服务等。puppet把这些系统实体称之为资源，puppet的设计目标是简化对这些资源...

  • Puppet 4 性能提升超2倍，升级前应该你知悉的变化

    1、激动人心的改进Puppet4的第一个正式版本于2015年4月15日发布截止到2016年12月28日Puppet已正式发布了4.8.1版本。Puppet4与3.x...

  • 第三章 图像映射

    git mv README.rdoc README.md $ git commit -a -m "Improve the README" 图 3.1：为示例程序在 GitHub 新建一个仓库 这个程序在本书的后续章节会一直使用，所以建议你在 GitHub 新建一个仓库（如图 3.1），...

  • 《第一本Docker书》 读书笔记

    它是由Docker公司免费发布的产品,也被包含在Docker Toolbox之中。 第3章Docker入门 3.1确保Docker已经就绪 [root@liruilong ~]# docker info Containers: 4 Running: 2 Paused: 0 Stopped: 2 Images: 3 Server ...

  • redis3.0集群安装详解

    安装文档 1.安装依赖 yum -y install gcc yum -y install gcc-c++ yum -y install ruby yum -y install rubygem* yum ...

  • 4. 动态添加节点 4.1. 准备两个redis做主备

     安装依赖 yum -y install gcc yum -y install gcc-c++ yum -y install ruby yum -y install rubygem* yum -y install ruby-rdoc yum -y install ruby-devel rubygems rpm-build gem install redis2. 部署方案1. ...

  • gitlab4.0->5.0->6.0->7.14->8.0->8.2升级

    参考官方文档： https://gitlab.com/gitlab-org/gitlab-ce/tree/master/doc/update 本地服务器为4.0.1版本 1）4.0.1-&gt;4.1 sudo service gitlab stop cd /home/gitlab/gitlab/ sudo -u gitlab -H git fetch ...

  • redis安装步骤 详解 noSQL操作步骤以及无法安装异常处理

     而且会以集群的形式存在(redis的官方文档中说明redis集群是必须存在于三主三从)  redis必须要部署在6台服务器上(也就是说需要有6台电脑(6台虚拟机))  1台虚拟机内存是1G---&gt;6G  还不包括windows以及软件所...

  • Linux下安装Redis详细教程

     而且会以集群的形式存在(redis的官方文档中说明redis集群是必须存在于三主三从)  redis必须要部署在6台服务器上(也就是说需要有6台电脑(6台虚拟机))  1台虚拟机内存是1G---&gt;6G  还不包括windows以及软件所...

  • ubuntu安装docker

    docker需要64位系统并且内核版本至少为3.10.x，如果内核低于3.10.x需要先升级内核。 查看当前内核版本 uname -r 3.19.0-15-generic #官方脚本安装 curl -sSL https://get.docker.com/ | sh docker version #根据...

  • OFDM、OOK、PPM、QAM 的误码率模拟【绘制不同调制方案的误码率曲线】附Matlab代码.rar

    1.版本：matlab2014/2019a/2024a 2.附赠案例数据可直接运行matlab程序。 3.代码特点：参数化编程、参数可方便更改、代码编程思路清晰、注释明细。 4.适用对象：计算机，电子信息工程、数学等专业的大学生课程设计、期末大作业和毕业设计。

  • 8c71b76fb2ec10cf50fc6b0308d3dcfc_9545878e2b97a84b2e089ece58da9e82.png

    8c71b76fb2ec10cf50fc6b0308d3dcfc_9545878e2b97a84b2e089ece58da9e82

  • Android SO逆向-对象的拷贝构造函数.pdf

    Android逆向过程学习

  • 基于S7-200 PLC的糖果包装控制系统设计与实现

    内容概要：本文详细介绍了基于西门子S7-200 PLC的糖果包装控制系统的设计与实现。首先阐述了PLC在工业自动化领域的优势及其在糖果包装生产线中的重要性。接着深入探讨了系统的硬件连接方式，包括传感器、执行机构与PLC的具体接口配置。随后展示了关键的编程实现部分，如糖果计数、包装执行、送膜控制、称重判断以及热封温度控制等具体梯形图代码片段。此外，还分享了一些实用的经验技巧，如防止信号抖动、PID参数优化、故障诊断方法等。最后总结了该系统的优势，强调其对提高生产效率和产品质量的重要作用。 适合人群：从事工业自动化控制、PLC编程的技术人员，尤其是对小型PLC系统感兴趣的工程师。 使用场景及目标：适用于糖果制造企业，旨在提升包装生产线的自动化程度，确保高效稳定的生产过程，同时降低维护成本并提高产品一致性。 其他说明：文中不仅提供了详细的理论讲解和技术指导，还结合实际案例进行了经验分享，有助于读者更好地理解和掌握相关知识。

  • PLC与WinCC实现三部十层电梯协同控制及优化技巧

    内容概要：本文详细介绍了参与西门子杯比赛中关于三部十层电梯系统的博图V15.1程序设计及其WinCC画面展示的内容。文中不仅展示了电梯系统的基本架构，如抢单逻辑、方向决策、状态机管理等核心算法（采用SCL语言编写），还分享了许多实际调试过程中遇到的问题及解决方案，例如未初始化变量导致的异常行为、状态机遗漏空闲状态、WinCC画面动态显示的挑战以及通信配置中的ASCII码解析错误等问题。此外，作者还特别提到一些创意性的设计，如电梯同时到达同一层时楼层显示器变为闪烁爱心的效果，以及节能模式下电梯自动停靠中间楼层的功能。 适合人群：对PLC编程、工业自动化控制、电梯调度算法感兴趣的工程技术人员，尤其是准备参加类似竞赛的学生和技术爱好者。 使用场景及目标：适用于希望深入了解PLC编程实践、掌握电梯群控系统的设计思路和技术要点的人士。通过学习本文可以更好地理解如何利用PLC进行复杂的机电一体化项目的开发，提高解决实际问题的能力。 其他说明：文章风格幽默诙谐，将严肃的技术话题融入轻松的生活化比喻之中，使得原本枯燥的专业知识变得生动有趣。同时，文中提供的经验教训对于从事相关领域的工作者来说非常宝贵，能够帮助他们少走弯路并激发更多创新思维。

  • 慧荣量产工具合集.zip

    慧荣量产工具合集.zip

  • 永磁同步电机FOC控制与SVPWM算法仿真模型解析

    内容概要：本文详细介绍了永磁同步电机（PMSM）的FOC（磁场定向控制）和SVPWM（空间矢量脉宽调制）算法的仿真模型。首先解释了FOC的基本原理及其核心的坐标变换（Clark变换和Park变换），并给出了相应的Python代码实现。接下来探讨了SVPWM算法的工作机制，包括扇区判断和占空比计算的方法。此外，文章还讨论了电机的PI双闭环控制结构，即速度环和电流环的设计与实现。文中不仅提供了详细的理论背景，还分享了一些实用的编程技巧和注意事项，帮助读者更好地理解和应用这些算法。 适合人群：电气工程专业学生、从事电机控制系统开发的技术人员以及对永磁同步电机控制感兴趣的科研人员。 使用场景及目标：① 学习和掌握永磁同步电机的FOC控制和SVPWM算法的具体实现；② 提供丰富的代码示例和实践经验，便于快速搭建和调试仿真模型；③ 探讨不同参数设置对电机性能的影响，提高系统的稳定性和效率。 其他说明：文章强调了在实际应用中需要注意的一些细节问题，如坐标变换中的系数选择、SVPWM算法中的扇区判断优化以及PI控制器的参数调整等。同时，鼓励读者通过动手实验来加深对各个模块的理解。

Global site tag (gtag.js) - Google Analytics