rdoc是生成ruby代码api文档的工具,跟javadoc的功能类似,在命令行中输入rdoc,它能够遍历当前目录的ruby源代码文件(以.rb或.rbw为扩展名)进行解析然后生成规范的ruby api文档。可以用rdoc --help来查看具体的命令行参数。rdoc对注释内的特殊标签进行解析并将输出格式化,比如以下一段注释:
# Just for fun
# - one
# - two
# - three
# [cat] small domestic animal
#
# <em>Italic</em> <b>Bold</b>
#
#--
#Hi, dont doc me please!
#++
# Author:: hihi(http:blog.hihi.com)
def demo_method1(a,b)
end
"-":代表缩进的符号列表
"[]":代表描述列表,方括号内的是被描述的对象,比如这里是cat,跟着的是描述说明,描述说明将换行缩进显示
"<em></em>":表示文本为斜体
"<b></b>":表示文本为粗体
"-- ++":之间的文本不会被解析,也就是在api文档中看不到这段文本
"http:":文本为超链接
"::":冒号
具体用法可参考
http://rdoc.sourceforge.net/doc/index.html
后面的图是上述注释生成的文档结果。
- 大小: 17.9 KB
分享到:
相关推荐
Ruby文档系统¶↑主页github.com/ruby/rdoc rdoc ruby.github.io/rdoc错误github.com/ruby/rdoc/issues代码质量描述¶↑RDoc为Ruby项目生成HTML和命令行文档。 RDoc包含用于从命令行生成和显示文档的rdoc和ri...
RDoc - 用于为Ruby项目生成HTML和命令行文档,RDoc包括RDoc和ri工具用于从命令行生成和显示文档。
RDoc是针对Ruby源代码的文档系统。跟JavaDoc一样,RDoc可以读取原文件,分析源代码中的语法信息和...Ruby的内建库和标准库文档都是用RDoc生成的。应该可以使用ri命令来访问这些文档,不过这也取决于你安装Ruby的方式。
rdoc:RDoc为Ruby项目生成HTML和在线文档
RDoc 是一套基于React的文档生成工具,用于生成文档网站或简单的博客网站
ruby的rdoc模板,ruby代码生成文档的工具模板
ajax-rdoc:Ruby源代码的Rdoc模板和生成器,使用javascript使得搜索方法和类非常容易
Hanna-nouveau是可扩展的RDoc生成器。 它在Haml中实现,使源代码干净且可读。 它建立在Hanna-nouveau的简洁,美观和易于浏览的基础上。↑基于Mislav的原始Hanna。 Hanna-nouveau是可扩展的RDoc生成器。 它在Haml中...
下载地址:http://files.rubyforge.vm.bytemark.co.uk/rdoc-chm/ 在线: http://www.ruby-doc.org/core/
rubydoc.info, 下一代 rdoc.info 站点 RubyDoc.info: 货场Doc服务器RubyDoc.info 是下一代的ruby doc服务器,替换 http://rdoc.info 和 http://yardoc.org/docs 。 这里文档服务器使用,来动态生成项目文档
Rain 是一个可生成美观且可定制的 API 文档的宝石,其灵感来自 yard 和 rdoc。 rain 的目标是从混合了 Markdown 的 ruby 注释语法生成漂亮的 API 文档。 该文档可以内嵌在 .rb 文件中,或者单独的 .md 或 ....
Hanna - RDoc格式化,构建成简单、漂亮和易于浏览
ruby语言的api文档,由rdoc工具从源代码生成,chm格式,支持全文搜索
Ruby文档工具摘要YARD是Ruby编程语言的文档生成工具。 它使用户能够生成一致且可用的文档,并可以将其导出到YARD:是的! Ruby文档工具摘要YARD是用于Ruby编程语言的文档生成工具。 它使用户能够生成一致,可用的...
rubyref.net-Ruby文档重定向源代码-导航到文档的简写。 受启发。 例子: awesome.rubyref.net → https://github.com/markets/awesome-rubybook.rubyref.net → ...
YARD是用于Ruby编程语言的文档生成工具。 它使用户能够生成一致,可用的文档,并且可以非常轻松地将其导出为多种格式,并且还支持扩展自定义Ruby构造,例如自定义类级别定义。 以下是YARD的一些显着功能的摘要。 ...
ruby-sunlight, 日光实验室API的ruby 包装器 日光实验室 API gem注意:这个文件是在 Textile 中的格式,在上是最好的视图。请参见 RDoc.info 完整的RDoc 。描述一个与日光实验室API集成的小 gem 。 从官方站点:日光...
Hoe随附了用于您所有常规项目任务的插件,包括rdoc生成,测试,打包,部署和发布。 请参阅类rdoc以获取帮助。 提示:`ri Hoe`或下面列出的任何插件。 要获得更多好处,请参阅: 功能/问题: ↑ 包括一个动态...
ruby资源文件,ruby rdoc.gem文件,离线ruby文件包
C:\>gem envRubyGems Environment: - RUBYGEMS VERSION: 1.3.7 - RUBY VERSION: 1.8.6 (2007-09-24 patchlevel 111) [i386-mswin32] - INSTALLATION DIRECTORY: c:/ruby/lib/ruby/gems/1.8 - RUBY EXECUTABLE: c:/...