ruby-on-rails - RDoc 中的“下划线”\“哈希”含义

Question

我正在使用 Ruby on Rails 3.0.7，并试图了解RDoc系统是如何工作的。所以我想了解当官方文档在第 7 行提到“哈希”值是什么意思：

1. 类的名称、源文件以及任何包含下划线或前面带有井号 字符的方法名称都会自动从注释文本超链接到它们的描述。

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

---

顺便说一句：您是否有参考 RDoc 的“必须阅读”资源？如果是这样，你能提供吗？

Answer 1

他们的意思是#符号。

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