请大神指教 ruby 文档化如何用代码实现,或给个例子也行。谢谢!!
@jky 太客气了。
如果是生成的话,README 里面就有啊
gem 'rdoc'
require 'rdoc/rdoc'
options = RDoc::Options.new
# see RDoc::Options
rdoc = RDoc::RDoc.new
rdoc.document options
# see RDoc::RDoc
#5 楼 @jky RDoc::RDoc#document
: https://github.com/rdoc/rdoc/blob/8155abb54dcb31607fe6cafbf926984862baa84c/lib/rdoc/rdoc.rb#L456
是這個麼?
#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}"
@jky 我说的 system 是直接呼叫 ri 或者 rdoc 的命令行,命令行里面有什么参数,文档里都有,或者通过rdoc --help
看一下。你通过 system 就可以加入程序自编的参数。另外,真的不知道你的需求是什么。
有一个-o
的选项可以指定目标文件夹,你把它制定到~/vagrant
不就可以了。这个文件夹是共享的,主机也可以看。
话说这个需求真的很奇怪。一般都是开发机器生成文档,远程不生成的。