rails有内置rdoc文档,但是当用到你自己配置的文件来解析生成到文档里就可不好弄了!也许对于高手来说很容易,但这是针对新手的文章。
要生成文档首先要修改生成文档的样式,更改路径在
Ruby\lib\ruby\1.8\rdoc\generators\template\html里的html文件,在此文件最下面有生成文档的格式。
此时你要在工程的lib\tasks下写个rake任务,或者ruby文件都行
desc "创建共享文档"
task :create_doc do
val = []
key = []
hsh = {}
html = {}
content = File.read("config/rubyamf_config.rb")
content.gsub(/#.*$/,"").scan(/ClassMappings\.register\(\s+(.*?)\)/m) do |item|
val << item
end
val.each do |k|
k.to_s.scan(/actionscript.*'[A-Z][a-z]*'/) do |ke|
ke.to_s.scan(/'[A-Z][a-z]*'/) do |keey|
#puts keey
hsh["#{keey.to_s[1..-2]}"] = k.to_s.scan(/.*[\,|\]]/)
end
end
end
content.gsub(/#.*$/,"").scan(/'[A-Z][a-z]*'/m) do |ke|
key << ke
end
key.uniq!.sort!.map! { |i| "<a href='classes/#{i[1..-2]}.html' target='docwin'>"+ i[1..-2] + "</a><br/>" }
HTML_LEFT = %{
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<link rel="stylesheet" href="rdoc-style.css" type="text/css" />
<title>ClassMappings.register</title>
</head>
<body>
<div id="index">
<h1 class="section-bar">Classes</h1>
<div id="index-entries">
#{key.each{ |i| i}}
</div>
</div>
</body>
</html>
}
hsh.each do |ke,va|
html["#{ke}"] = %{
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>#{ke}</title>
</head>
<body>
参数:
#{va.map!{|p| "<p>"+ p.delete(",") +"</p>"}}
</body>
</html>
}
end
writefile = File.new("doc/app/left.html" , "w")
writefile.write(HTML_LEFT)
html.each do |ke,va|
writefile = File.new("doc/app/classes/#{ke}.html" , "w")
writefile.write(va)
end
end
当然,你有更好的html页面设计
此rake会覆盖你生成文档的classes文件里面的类的html。之后的效果就是
现在就可以rake doc:app
之后再 rake create_doc
效果见下面。点击类名就会到对应的配置项!配置文件的解析就要你自己来了!
- 大小: 80.7 KB
- 大小: 34.7 KB
分享到:
相关推荐
在Rails中,可以修改`config/application.rb`或`config/environments/development.rb`等文件来设置相关选项。 ### 7. 使用`go_on_rails`生成其他Go组件 除了生成整个Go应用,`GoOnRails`还可以生成模型、控制器等...
dotfiles, 用于 zsh bash 完成gem git irb Rails vim的配置文件 orenstein文件的这些是配置文件,以我喜欢的方式设置系统。vim用户可能在我的中找到有用的东西,而且还有我的 ruby Fragment 。我也是一个非常激进的...
总结来说,这个主题涵盖了Rails开发、RSpec测试、文档生成以及可能的文件转换技术。要深入学习这个话题,你需要熟悉Rails、RSpec的使用,理解CHM文件的结构,以及如何使用适当的工具和技术将代码行为测试和文档生成...
rails_layout, 为各种前端框架生成 Rails 应用程序布局文件 RailsLayout gem使用这里 gem 可以设置你选择的前端框架的布局文件:Zurb基础 5.3Bootstrap 4.0Bootstrap 3.3它还将为 Bootstrap 或者基础设置设计视图。...
默认情况下,Rails应用将运行在3000端口上,但也可以通过修改配置文件指定其他端口号。 - 如果3000端口已被占用(如Apache占用80端口),可以尝试使用其他端口,例如3001或3002。在命令行输入`Ctrl+C`可停止当前...
标题与描述概述的知识点主要集中在Rails 2与Rails 3之间的关键差异,这些差异涉及到脚本命令、配置文件以及路由的处理方式。以下是对这些知识点的详细解释与扩展: ### 脚本命令的变化 在Rails 2中,开发者通过一...
很棒的Vim配置文件这将允许您运行mac vim并在Ruby on Rails上进行开发。 一些功能包括: 图形用户界面和终端有16种颜色的漂亮主题。 (ir_black和xterm16) 默认情况下忽略大小写的增量搜索交换和备份不碍您安装:您...
在项目目录中运行: $rails s我的方法思考过程当我得到问题陈述时,这些是我最初的指导性问题: 从用户的角度来看,真正的问题是什么? 成功会是什么样? 我需要测试什么才能确保其正常工作? 我将如何对数据建模?...
跟JavaDoc一样,RDoc可以读取原文件,分析源代码中的语法信息和注释文本,生成HTML格式的文档。和JavaDoc不同的是,即便源代码没有任何注释,RDoc也能生成相当漂亮的文档内容。在编写源程序的同时编写RDoc可以说...
总的来说,配置Ruby on Rails的数据库涉及到安装必要的数据库驱动和Rails框架,然后在`database.yml`文件中正确设定数据库连接参数。理解这个过程对于开发基于Rails的应用程序至关重要,因为这使得Rails能够与各种...
Rails Erd gem的工作原理是扫描Rails应用中的模型文件,解析出其中的关系定义,并将这些信息转换成一个可视化的图形。这样,开发者可以快速查看并理解整个应用的数据结构,便于进行数据库设计、调试或者重构。 要...
4. 修改`database.yml`配置文件 5. 初始化和迁移数据库 文件"libmySQL.dll"是MySQL客户端库的一部分,用于Rails应用连接到MySQL数据库。确保这个文件在系统路径中或者Rails应用的bin目录下,以便Rails能够正确地与...
通过`config/routes.rb`文件,你可以自定义路由规则,指定URL如何被解析。 五、Rails生成器 Rails提供了许多命令行工具,如`rails generate`,可以自动生成模型、控制器、迁移等,大大减少了手动编码的工作量。 六...
运行`rails -d mysql abc`创建名为abc的新项目,然后在项目的config目录下修改`database.yml`文件,输入正确的MySQL连接参数。启动Rails服务器(`ruby script/server`),访问`http://localhost:3000`,如果看到关于...
在本文中,我们将深入探讨如何在您的计算机上安装和配置Ruby 1.8.6、Rails 2.0.2、RadRails 0.7.2 IDE以及MySQL数据库。这是一个适用于初学者和有一定经验的开发者的技术指南,旨在帮助您创建一个稳定的开发环境,...
`sitemap_generator` gem 是一个适用于Ruby on Rails框架的开源工具,它能够自动扫描你的Rails应用,生成包含所有路由的Sitemap。安装这个gem非常简单,只需要在Gemfile中添加以下行: ```ruby gem 'sitemap_...
### Ruby on Rails与RadRails环境配置详解 #### 一、Ruby on Rails简介 Ruby on Rails(简称Rails或RoR)是一种使用Ruby语言编写的开源全栈Web应用框架。它遵循模型-视图-控制器(MVC)架构模式,强调代码优雅性和...
9. **了解Rails命令**:Rails提供了一系列的命令行工具,如`rails generate`(用于生成模型、控制器、迁移等),`rails console`(提供了一个交互式的Ruby环境,方便测试和调试),`rails dbconsole`(直接进入...