Ruby rdoc 文档化如何用代码实现?

jky · 2014年05月13日 · 最后由 billy 回复于 2014年05月15日 · 3066 次阅读

请大神指教 ruby 文档化如何用代码实现,或给个例子也行。谢谢!!

什么叫代码实现。你先给个例子吧。

#1 楼 @billy 我意思是不在 linux 终端用命令生成,而是用一个方法来生成。我不太懂这个,也许表达会有问题望见谅。

@jky 太客气了。

如果是生成的话,README 里面就有啊

gem 'rdoc'
require 'rdoc/rdoc'

options = RDoc::Options.new
# see RDoc::Options

rdoc = RDoc::RDoc.new
rdoc.document options
# see RDoc::RDoc

https://github.com/rdoc/rdoc

#3 楼 @billy 谢谢!我去看看

#3 楼 @billy 你说的这个我还是知不知道如何实现啊,能具体点不呢? 这个不知道怎么用

#6 楼 @blacktulip 这个是 gem 里的 rdoc.rb 文件?我想要个例子实现自动生成文档,用方法实现http://rdoc.rubyforge.org/#label-Description这个全英文的喔看不懂

@jky 测试里面写了详细的过程: https://github.com/rdoc/rdoc/blob/8155abb54dcb31607fe6cafbf926984862baa84c/test/test_rdoc_rdoc.rb

其实就算不调用方法,你也可以通过 system 来呼叫 ri 并加选项system "ri #{my_options}"

#8 楼 @billy 谢谢了!我去试着写一下

#8 楼 @billy 这个测试是一个例子还是 rdoc 的类库呢?system "ri #{my_options}"貌似一点头绪都没有

#8 楼 @billy 如果我通过 system 来回叫的话,我生成的文件如何在客户机打开呢?我在服务器上打开的这样子,我在客户机上如何能这样的打开呢

@jky 我说的 system 是直接呼叫 ri 或者 rdoc 的命令行,命令行里面有什么参数,文档里都有,或者通过rdoc --help看一下。你通过 system 就可以加入程序自编的参数。另外,真的不知道你的需求是什么。

#12 楼 @billy 我的需求是这样的,比如我的项目在虚拟机上运行的,用 rdoc 命令生成文件到指定的目录下去在我本机也能访问到生成的文件页面。

有一个-o的选项可以指定目标文件夹,你把它制定到~/vagrant不就可以了。这个文件夹是共享的,主机也可以看。

话说这个需求真的很奇怪。一般都是开发机器生成文档,远程不生成的。

需要 登录 后方可回复, 如果你还没有账号请 注册新账号