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

Rdoc介绍

    博客分类:
  • Ruby
阅读更多

    Rdoc是针对Ruby源代码的文档系统。Rdoc可以读取源代码文件,分析源代码中的语法信息和注释文本,生成html格式的文档。Ruby的内建库和标准文档都是用RDoc生成的。我们可以用 命令访问。

   如果用RubyGems来安装Rails的,运行 gem server ,可以看到

       (Server started at http://0.0.0.0:8808

   然后我们用浏览器访问http://localhost:8808

rake doc:app 命令可以为Rails项目创建html格式的文档,并将其放在doc/aap目录下

分享到:
评论

相关推荐

    ajax-rdoc:Ruby源代码的Rdoc模板和生成器,使用javascript使得搜索方法和类非常容易-ajax source code

    **Rdoc介绍** Rdoc是一种元编程工具,它可以解析Ruby源代码文件中的特殊注释块,并将这些注释转换为HTML文档,提供类、模块、方法等的详细信息。Rdoc支持多种格式的输出,包括HTML、Text、Manpage等,便于开发者...

    rdoc:原生Go中的无冲突复制JSON实现

    博士 rdoc(复制的文档):在Go中构建更好的去中心化和脱机优先应用程序 rdoc是Martin Kleppmann和Alastair R.... 很好地介绍了马丁·克莱普曼(Martin Kleppmann)和Alastair R. Beresford撰写的原始论文

    vim-preview:用于预览标记文件(markdown,rdoc,textile,html)的Vim插件

    介绍 预览插件是一种开发的工具,可帮助您在编辑标记文件时预览.markdown,.rdoc,.textile和.html等标记文件。 它生成html文件并在浏览器中打开它们。 支持的格式 该插件支持以下格式: 降价(MD,MKD,mkdn,m...

    生成Ruby的离线文档

    在描述中提到的“博文链接:https://ggtalk.iteye.com/blog/1928277”,虽然没有提供具体的内容,但通常这样的博客文章会详细介绍如何利用特定工具或方法生成Ruby的离线文档。通常,这可能涉及到以下步骤: 1. **...

    doxygen文档生成

    通过以上介绍,我们可以看出Doxygen是一个强大且灵活的文档生成工具,它极大地简化了程序员的文档工作,提高了代码的可读性和维护性。无论是小型项目还是大型项目,Doxygen都是一个值得信赖的文档生成伙伴。在实践中...

    Pragmatic.Programming.Ruby.1.9.Apr.2009.pdf

    本书详细介绍了Ruby 1.9版本的特性和编程实践,对于学习和掌握Ruby语言具有重要的指导意义。 ### Ruby 1.9 的特性 Ruby 1.9是Ruby语言的一个重大更新,它引入了多项改进和新特性,包括但不限于性能优化、新的字符...

    Ruby高级编程教程-世界顶级高校教材(完整版827页)

    - 常用选项及其功能介绍。 - **交互式Ruby Shell (irb) 的使用** - irb的基本操作与特点。 - 在irb中调试代码的方法。 - **代码文档化** - 使用RDoc或其他工具为项目添加文档。 - 文档化最佳实践。 - **Ruby...

    R_doc

    例如,`ggplot2`包提供了数据可视化的工具,它的文档会详细介绍如何创建各种复杂的图表;`dplyr`包用于数据操作,文档则涵盖了如何进行筛选、排序、分组等操作。 4. **R语言的学习资源**: - **R语言官方文档**:...

    Pragmatic.Programming.Ruby.1.9

    - **文档工具**:介绍Ruby官方提供的文档工具RDoc和ri,帮助开发者更好地理解和使用Ruby。 #### 2. **面向对象编程** - **基本概念**:解释Ruby作为一门面向对象语言的核心概念。 - **数组和哈希**:探讨如何使用...

    Python的包管理工具Pip

    接触了Ruby,发现它有个包管理工具RubyGem很好用,并且有很完备的文档系统http://rdoc.info 发现Python下也有同样的工具,包括easy_...不过,我没有细看easy_install的方法,这就简单的介绍一下Pip的安装与使用:

    Windows下Redmine-1.3.0安装笔记

    本文档将详细介绍如何在Windows 7系统下安装Redmine 1.3.0版本,并结合Ruby、Ruby on Rails以及MySQL等技术栈,帮助用户顺利完成部署。 #### 二、安装前准备 1. **操作系统**: Windows 7 2. **Redmine版本**: ...

    watir-bonus-1.5.2

    1. **rdoc** - 这通常是Ruby文档生成器RDoc生成的API文档,用于详细介绍Watir-Bonus库的各种类、方法及其用法。通过阅读这些文档,开发者可以了解如何利用Watir-Bonus进行测试脚本的编写,找到具体的方法来执行各种...

    Programming Ruby 1.9 3rd edition

    - **第1章**:“开始使用Ruby”,从命令行环境入手,讲解了如何安装Ruby、运行Ruby程序以及如何使用Ruby文档工具如RDoc和ri等。 - **第2章**:“Ruby的新特性”,进一步探讨了Ruby作为一门面向对象的语言的特点,并...

    ruby-saslwrapper-0.16-5.el7.x64-86.rpm.tar.gz

    - readme.md:通常包含项目的介绍、安装指南、使用说明或者版权声明等内容。 - ruby-libs-2.0.0.648-39.el7_9.x86_64.rpm:这是Ruby的库文件包,包含了Ruby语言运行时所需的库文件。 - rubygem-rdoc-4.0.0-39.el7_9....

    well-grounded-rubyist-book-notes:我在Jupyter Lab(Ruby内核2.7.0)中实现的“ The Well-Grounded Rubyist”(Black&Leo)的工作笔记。

    irb,rdoc,ri,rake,gem,erb与对象交谈创建一个对象天生的对象行为方法参数局部变量和赋值类和实例实例变量和对象状态设置方法属性遗产类作为对象和消息接收者常数自然与养育介绍模块,类和方法查找method_...

    centos6 安装redmine+apache2

    本资源摘要信息介绍了在 Centos 6 系统上安装 Redmine 和 Apache2 的步骤和要求。Redmine 是一个基于 Web 的项目管理工具,使用 Ruby on Rails 框架开发,需要特定的 Ruby 和 Rails 版本。下面是安装 Redmine 和 ...

    ruby_on_rails&radrails环境配置.pdf

    - 在`Ri/rdoc`中选择`ruby\bin`目录下的`ri`和`rdoc`文件。 - **配置Rails** - 在`Window > Preferences > Rails > Configuration`中设置`Rails Path`,选择目录下的`rails`文件。 - **配置Rake** - 如果未...

    RailsWithApacheAndMongrel.pdf

    - **RDoc**: 生成文档工具,可选但建议安装。 - **Rails**: 主要开发框架,需通过Rubygems安装。 - **RMagick**: 图像处理库,对于涉及图像处理的应用非常有用。 - **Mongrel**: Web服务器,特别适合部署Rails...

Global site tag (gtag.js) - Google Analytics