问题:如何使用Doxygen记录Ruby代码？免责声明:我知道ruby​​已经有一个内置的文档系统，可能还有其他方法可以做到这一点，但我操作的具体限制是如何让Doxygen完成这项工作(假设它是可能的). 最佳答案 简短的回答，没有。长答案，仍然没有。Doxygen最终会用于Ruby，但我不认为它会很快发生。短期内，您只能使用RDoc或YARD。 关于ruby-如何使用Doxygen记录Ruby代码？，我们在StackOverflow上找到一个类似的问题： h

我正在使用YARD使用makrdown作为脚本解析器为我的Rails应用程序生成文档。大多数文档功能开箱即用。但是，我还想将模型属性记录为一个，记录模型上的可用属性列表和两个，以描述它们的语义。我无法在YARD中找到对此的任何特殊支持，我基本上只能在类注释中简单地列出属性。有没有办法记录动态生成的模型属性，以便它们像标准属性/方法一样出现在文档中？附言我已经使用annodate-modelsgem在类列表的顶部生成基本模式转储，但这并不是我真正想要的。 最佳答案 似乎YARD现在有自己的@!attribute(注意感叹号)标签用于此

关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题？更新问题，以便editingthispost可以用事实和引用来回答它.关闭5年前。Improvethisquestion关于如何/在何处指定应用程序的版本号是否有任何约定？例如，对于ruby​​gems，lib/mygem/version.rb是通常用于该目的的文件。我的猜测是像这样创建config/version.rb文件:moduleMySiteVERSION="0.0.4"#orinMySite::Applicationclass##classApplication#VERSION="0.0.4"#e

关闭。这个问题是off-topic.它目前不接受答案。想改进这个问题吗？Updatethequestion所以它是on-topic用于堆栈溢出。关闭10年前。ImprovethisquestionRailsGuides是否有可下载的离线版本？？

关闭。这个问题不符合StackOverflowguidelines.它目前不接受答案。我们不允许提问寻求书籍、工具、软件库等的推荐。您可以编辑问题，以便用事实和引用来回答。关闭5年前。Improvethisquestion我正在寻找有关Ruby语法的权威文档。我知道核心API和标准库的权威文档，但语法本身呢？例如，这样的文档应该包括:保留字、字符串字面量语法、变量/类/模块的命名规则、所有条件语句及其排列等等。我知道有很多书籍和教程，是的，但是每一本本质上都是一个教程，每本都有不同的深度和重点。为了简洁和叙述流畅，它们都将省略作者认为无关紧要的某些语言细节。例如，您是否知道可以使用没有

对于基本的Ruby方法，我会为以下格式的参数提供YARD样式文档。#@paramquery[String]Thesearchstringtoquery.#@paramoptions[Hash]Optionalsearchpreferences.defsearch(query,options={})#...end在Ruby2.0中，现在可以使用关键字参数。但是，我不确定如何根据YARD文档处理该问题。defsearch(query,exact_match:false,results_per_page:10)#...end在第二种情况下，我将如何记录exact_match和results_

在修改elasticsearch时,用_update进行局部修改,修改失败,报错{    "error": {        "root_cause": [            {                "type": "invalid_type_name_exception",                "reason": "Document mapping type name can't start with '_', found: [_update]"            }        ],        "type": "invalid_type_name_exce

我最近更新到MountainLion并重新安装了Ruby，但是当我尝试运行测试Rails应用程序时，我收到一条错误消息，指出“我的系统当前未安装Rails”。我按照它说的做，输入sudogeminstallrails并得到:clearedfaster_requirecachesduetonewgeminstall...Successfullyinstalledrails-3.2.71geminstalledInstallingridocumentationforrails-3.2.7...InstallingRDocdocumentationforrails-3.2.7...但是当我检

关闭。这个问题是opinion-based.它目前不接受答案。想改善这个问题吗？更新问题，以便可以通过editingthispost用事实和引文回答问题.3年前关闭。Improvethisquestion我不确定这里的最佳实践是什么，但我经常看到缩写的变量名，尤其是当范围很小的时候。所以(使用简单的Ruby示例)而不是defadd_location(name,coordinates),我看到类似defadd_loc(name,coord)的东西——我什至可能会看到类似defadd_loc(n,x,y)的东西.我想当人们习惯于看到缩写时，更长的名字可能会让他们感到疲倦。冗长是否有助于可读

关闭。这个问题不符合StackOverflowguidelines.它目前不接受答案。我们不允许提问寻求书籍、工具、软件库等的推荐。您可以编辑问题，以便用事实和引用来回答。关闭4年前。Improvethisquestion过去我使用railsbrain.com有一个很好用的离线api文档。但他们停在了2.3.2版本有没有其他最新版本的解决方案。