RDoc 中的“下划线”\“哈希”含义

Question

我正在使用 Ruby on Rails 3.0.7，并试图了解 RDoc 系统的工作原理。所以我想了解当official documentation 引用第 7 行时的“哈希”值是什么意思：

1. 类名、源文件名和任何包含 下划线或前面有 散列 字符是自动的 从评论文本超链接到他们的 描述。

你能给我举个例子，在我的注释代码中说明这一点吗？您对使用它有什么建议吗？

---

顺便说一句：您是否有提及 RDoc 的“必读”资源？如果有，你能提供吗？

Answer 1

它们的意思是# 符号。

在文本中引用方法时，通常会在其前面加上一个哈希。例如：“要将数组转换为字符串，请调用 #to_s”。现在，rdoc 会注意到哈希并将其转换为方法 to_s 的文档链接。