问题标签 [yard]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
postgresql - 使用 postgis 的机房
我在Engineyard中有一个实例,我想安装postgis。
我和厨师一起尝试了几件事,但都没有成功。
有人在Engineyard上成功安装过postgis吗?你能告诉我你是怎么做到的吗?
ruby - 使用 YARD 记录模型属性
我正在使用YARD为我的 rails 应用程序生成文档,并将 makrdown 作为脚本解析器。大多数文档功能开箱即用。但是,我还想将模型属性记录为一个,记录模型上的可用属性列表和两个,以描述它们的语义含义。
我无法在 YARD 中找到对此的任何特殊支持,我基本上只需要在类注释中列出属性即可。有没有办法记录动态生成的模型属性,以便它们像标准属性/方法一样出现在文档中?
PS 我已经使用 annodate-models gem 在类列表的顶部生成基本模式转储,但这并不是我真正想要的。
ruby - 如何使用 yardoc 列出未记录的模块/类/常量/方法?
我有一个小型代码库,我正在使用YARD进行记录。当我运行yardoc
命令时,它告诉我:
我不想通过我所有的代码来查找未记录的常量和方法,而是希望它简单地列出未记录的项目。有人知道怎么做吗?
ruby - 院子里,如何将图像包含到文档中?
我想在码生成的文档中包含图像,但在任何地方都找不到如何做到这一点......有谁知道如何做到这一点?
ruby - 生成 RDoc 到 LaTeX
是否可以生成 LaTeX 格式的 RDoc?我查看了 RDoc 和 YARD,但没有找到我需要的东西。
我正在用 LaTeX 为我的 Ruby 项目编写文档,我需要一种方法来轻松地将 API 参考作为附录或章节嵌入到最终的 PDF 中。对我来说,最方便的是从 Ruby 源文件生成 LaTeX 源并在适当的地方包含它。
ruby - 使用 yard 创建文档时如何防止 [查看源代码] 链接?
我正在使用 yard 生成项目文档,但我不想在文档中显示 [查看源代码] 链接,我已经深入研究了 yard 官方指南但仍然没有得到解决方案。
有什么想法吗?谢谢。
ruby - 如何使用 Yard 记录可枚举类型及其包含的类型?
使用我可以编写的 ruby Yard doc 工具
但是,如果参数是可枚举的
以上是正确的方法吗?
ruby - YARD:记录自定义 getter/setter 对,例如 attr_accessor
我正在使用 YARD 来记录我的项目。使用创建的 YARD 文档属性
在单独的部分“实例属性摘要”中。现在我有另一个属性,但使用自定义 setter 和 getter
attr_accessor
所以基本上我的问题是,我怎样才能让 YARD 像前一种情况一样记录这对设置器/获取器,并some_other_attribute
在“实例属性摘要”中列出?
ruby-on-rails - 由 Yard 和西班牙口音生成的文档
我正在用 Yard 生成文档,我所有的评论都是用西班牙语写的。问题是 Yard 生成的文档包含 � 而不是西班牙口音。
我用过“yardoc”命令。我正在使用 ruby 1.8.7 (2011-02-18 patchlevel 334) [i386-mingw32] 和 Rails 3.0.7 在 Windows 7 上运行
ruby - 使用 YARD 将参数标记为可选(或具有默认值)
我正在使用 YARD 来记录我的代码。我有一个方法,它有一个带有默认值的可选参数。我如何指出该参数是可选的并且具有默认值?
例子: