ruby - 如何向将显示在 ruby​​gems.org 上的 gem 添加文档？

Question

尝试将我的第一个 gem 推送到 ruby​​gems.org，我正在尝试弄清楚如何为它生成在线文档。对于大多数 gems“显示”页面，当我单击“文档”链接时，我将转到 http://rubydoc.info/gems/gemname/version/frames .如果我在正确的位置生成文档，这会自动发生吗？我必须在 gemspec 中指定一些东西吗？谢谢!

Answer 1

rubydoc.info将为您的 gem 自动生成 API 文档。至少，这些文档将包含所有类、模块和方法的签名，以及您在每个方法和类之前添加的注释。

如果将 yardoc 标记添加到文件中，文档会变得更好。这是方法的一小部分 yardoc 标记:

# Validate the value.
# @param long_mailer_id truthy if the mailer ID is long (9 digits).
# @raise ArgumentError if invalid

def validate(long_mailer_id)

yardoc ，rubydoc.info 的文档引擎使用，将查找特定格式的注释并将它们格式化为漂亮的文档。

您还可以在 gem 的根目录中添加一个 README.md 在 Markdown 中格式。这将被格式化并用作文档的“主页”。