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

时间:2011-06-26 03:33:34

标签: ruby-on-rails ruby ruby-on-rails-3 documentation rdoc

我正在使用Ruby on Rails 3.0.7,我试图了解 RDoc 系统的工作原理。所以我想了解official documentation在第7行引用的“哈希”值意味着什么:

  
      
  1. 类的名称,源文件以及包含的任何方法名称   下划线或前面加上哈希   角色是自动的   从评论文本到他们的超链接   描述。
  2.   

你能举个例子说明我的注释代码吗?您对使用它有什么建议吗?


BTW :你有一个“必读”资源引用RDoc吗?如果是这样,你可以提供吗?

1 个答案:

答案 0 :(得分:2)

它们表示#符号。

当引用文本中的方法时,通常会为其添加哈希值。例如:“为了将数组转换为字符串,请调用#to_s”。现在,rdoc将注意到哈希并将其转换为方法to_s的文档的链接。