我喜欢使用Textile或Markdown为我的项目编写自述文件,但是当我生成RDoc时,自述文件被解释为RDoc并且看起来非常糟糕.有没有办法让RDoc通过RedCloth或BlueCloth而不是自己的格式化程序运行文件？可以配置为从文件后缀自动检测格式吗？(例如,README.textile通过RedCloth运行,但README.mdown通过BlueCloth运行)
这是交易,
如果您使用过Aptana,Eclipse甚至Microsoft Expression Web编辑器,那么您已经看到它们具有Balloon Text或Intellisense弹出窗口,其中显示了内置和自定义对象,方法等的提示/信息.
他们通过JSDoc,PHPDoc,JavaDoc,RDoc等获取信息.
我想在Vim中获得这些功能,也可以实现为omnicompletion,因为Mac/GVim也支持气球文本.
对于某些空白模块,运行RDoc没有意义.例如:
class moduleName::className < ActiveRecord::Base
def foo
end
def bar
end
end
RDoc生成报告:
moduleName -> blank HTML
moduleName::className -> complete documentation
如何删除moduleName,这是从报告生成中删除的？
任何帮助将不胜感激,谢谢.
我正在记录我正在编写的Ruby库.在我的README.rdoc文件中,我包含了一些使用一些演示Ruby代码的示例.
但是,生成的HTML文档不会显示带有语法突出显示的Ruby代码,而只是作为代码块.
当我查看http://rdoc.rubyforge.org/README_rdoc.html的来源时,我看到的只是一段Ruby代码,就像我在README.rdoc中包含的一样.是否有传递给rdoc命令的特殊选项？
好吧,我正在尝试为回形针生成rDoc,但是rake任务在它到达之前会阻塞另一个插件,所以这是不可能的:
rake doc:plugins
我可以去修复破碎的插件,但我很忙,很懒,所以我只想生成回形针的文档.有没有办法做到这一点？
是否有像rdoc,markdown等的wiki语法？在ruby世界中推荐？我有时会编写开源代码,并且没有粘合剂,我应该在Code文档和README文件中使用哪种语法.什么对我有用,为什么你使用它.
当我这样做时,我想要doc/README_FOR_APP出现的内容.doc/app/index.htmlrake doc:app
目前,内容是:
这是Rails应用程序文档的API文档.
要查看README_FOR_APP,我必须README_FOR_APP在左侧的页面列表中单击.
我已经看过如何重命名或移动Rails的README_FOR_APP,但OP断言他已经看到了我想要的行为.
我正在使用rails 3.1.3.
在官方文件表明，我应该能够建立使用我的应用程序文件rake doc:app，但是当我运行的Rails 5命令我得到下面的输出：
bwerth@bwerth-VirtualBox:~/rails/gep$ rake doc:app
rake aborted!
Don't know how to build task 'doc:app' (see --tasks)
(See full trace by running task with --trace)
在IRB或其他交互式解释器(如pry)中,如何获取有关对象和方法的内联文档？例如,我可以做到这一点:
[1] pry(main)> x = 'hello world'
=> "hello world"
[2] pry(main)> x.st
x.start_with? x.strip x.strip!
[2] pry(main)> x.st
但现在我想读取用法/接口/ rdoc对这些方法及其接口的说法.顺便说一句,那条中间线是制表完成的.
我正在寻找类似于ipython的东西,?可以将其附加到属性名称以查看docstring,甚至??可以查看源代码:
In [1]: x = 'potato'
In [2]: x.st
x.startswith x.strip
In [2]: x.strip?
Type: builtin_function_or_method
String Form:<built-in method strip of str object at 0x15e1b10>
Docstring:
S.strip([chars]) -> string or unicode
Return a copy of the string S with leading and trailing
whitespace removed.
If chars is given and not None, remove characters in chars …