Ruby的文档系统RDoc 3.10发布

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发行说明

相关推荐