今天完成了纳品工作,感觉就像刚去厕所爽一把出来。呵呵呵
做Javadoc还好,有我们亲爱的eclipse,但是做rubydoc就麻烦了,本来以为也是蛮简单的事情,不过,在网上几番搜索,不见效果,于是自己亲手操刀,慢慢的实验吧。
先说一下,自己在做的时候的经历:
从早上开始,我就不断的百度,发现根本不靠用,请教高手,高手也懒的理,于是乎,自己动手,丰衣足食。
首先,确保你的电脑上装有ruby的运行环境,如果有,就在cmd中运行rdoc,测试一下是否成功,ok后,开始第一步,按照标准将你的ruby代码注释完整,可以参考一下例子,当然最好在官网上。
第二部,整理你要生成文档的ruby程序,选择你要操作的ruby程序的N个,放在一个包下面。
第三部,打开cmd,找到你刚刚建立好的包,进入下面,然后,敲入rdoc *.rb --charset utf-8,这样保证你的文件不会出现乱码。当然你可以help一下。
如此,这样你就完成了。
当然你在测试rdoc的时候,出现问题,你的ruby环境下面没有rdoc,那么你就必须要下载rdoc,然后运行gem install rdoc.gem,安装完毕,开始第一步。
OK,3Q,今天再补上这一篇,帮助大家解决烦恼。
分享到:
相关推荐
rubydoc.info, 下一代 rdoc.info 站点 RubyDoc.info: 货场Doc服务器RubyDoc.info 是下一代的ruby doc服务器,替换 http://rdoc.info 和 http://yardoc.org/docs 。 这里文档服务器使用,来动态生成项目文档
Ruby-RDoc是Ruby编程语言中一个非常重要的工具,主要用于生成项目的HTML和命令行文档。它使得开发者能够方便地创建清晰、结构化的代码注释,进而自动生成易于理解的API文档,帮助其他开发者理解和使用项目。在Ruby...
RubyDoc 是一个开源的源代码文档生成工具,它主要用于解析 Ruby 语言的代码,并自动生成易于阅读和理解的文档。这个项目虽然已经终止,但它的影响力依然存在,尤其是在早期的 Ruby 社区中,RubyDoc 曾是重要的文档...
RubyDoc GitHub是一款方便开发者在GitHub上查看Ruby项目YARD文档的Chrome扩展程序。YARD是一种强大的Ruby文档生成工具,它允许程序员用注释的方式记录代码,然后自动生成易于阅读的文档。这款扩展使得用户无需离开...
这份“Ruby教程.chm”和“Ruby程序设计.doc”提供了学习Ruby的宝贵资源,旨在帮助初学者快速掌握Ruby的核心概念和编程技巧。 首先,让我们深入了解一下Ruby教程.chm。CHM是微软编写的帮助文档格式,通常包含索引、...
例如,对于一个名为`my_project`的项目,可以运行`rdoc --all --output doc my_project`,这会将所有Ruby文件的文档输出到`doc`目录。 2. **配置文件**:通过`.rdocopts`文件,可以设置默认的选项,如输出目录、...
它包含了各种内置模块和类,如`Array`、`String`、`Hash`等,以及一些实用工具,如`irb`(交互式Ruby shell)和`rdoc`(用于生成API文档的工具)。 绿化Ruby193的过程通常涉及以下步骤: 1. 下载Ruby193的完整源码或预...
Axlsx是一个用于生成符合Open XML标准的Excel(xlsx)文件的Ruby库,尽管它的主要目的是生成Excel文件,但通过一些定制,也可以创建Word兼容的DOCX文件。安装Axlsx gem: ```bash gem install axlsx ``` 接下来,...
在你的应用启动后,你可以通过访问`/api/swagger_doc`(默认路径,可自定义)来查看生成的Swagger UI。它将显示你定义的所有API端点,包括它们的描述、请求方法、参数等。用户可以通过UI直接测试API,这大大提高了...
- `rake doc:rerails`: 强制重新生成Rails核心的API文档。 - **日志管理** - `rake log:clear`: 清除log目录下的所有日志文件。 - **Rails管理** - `rake rails:freeze:edge`: 锁定应用到最新版本的Edge Rails...
在 Ruby 开发中,虽然有很多在线资源如 RubyDoc 提供了详细的 API 文档,但在没有网络连接或者需要快速查阅本地文档的情况下,手册页是一个非常实用的补充。Ruby-Manpages 项目可能包括以下方面的工作: 1. **创建...
AutoC是一个开源项目,主要由Ruby模块组成,专注于自动化C源代码的生成。这个工具集为开发者提供了一种高效的方法来处理C编程中的常见任务,尤其是对于那些涉及大量重复编码的工作,例如创建和管理数据结构。通过...
- create doc - create lib - create log - create public/images - create public/javascripts - create public/stylesheets - create script - create test/fixtures - create test/functional - create test/...
总结来说,这篇可能的博客文章会涵盖如何在Ruby环境中利用库(如Nokogiri)来解析、操作和生成XML文档,以及可能涉及到的工具和最佳实践。虽然具体的细节因博客内容缺失而未知,但以上提供的信息足以构建一个全面的...
总的来说,通过"Ruby入门教程v0.4.doc"和"OReilly.Ruby.Cookbook.Jul.2006.chm"这两个资源,初学者可以系统地学习Ruby语言的基础知识,理解其核心概念,并逐渐熟悉如何用Ruby解决实际问题。同时,不断实践和参与开源...
- `rake appdoc`: 为应用生成文档。 - **查看任务** - `rake --tasks`: 查看可用的任务列表。 - **代码统计** - `rake stats`: 查看代码统计数据。 - **启动服务器** - `ruby script/server`: 启动 Ruby 服务器...
这将使用Hanna-nouveau模板生成当前目录下的所有Ruby文件的文档,并将其保存在"doc"目录下。 Hanna模板的特点可能包括但不限于: 1. **简洁的布局**:Hanna注重清晰的页面结构,使文档易于导航。 2. **突出关键...
) 干净的默认模板与您现有的部署很好地集成对于Ruby爱好者-它是用Ruby写的导游如果您阅读此文章,则可能属于以下群组之一: 您想第一次{file:TRY.md试用Doc.js} 您需要更多{file:USE.md信息,如何使用Doc.js} 您...
生成的SDK RubyDoc可用。 用法示例 要调用API,您必须具有访问令牌,该令牌类似于以下示例: ll352u9jujauoqz4gstvsae05 。 您可以在用户界面的帐户>个人设置> API访问中找到访问令牌。 以下是一个简短的示例,向...