Значение подчеркивания \ hash в RDoc

Question

Я использую Ruby on Rails 3.0.7 и пытаюсь понять, как работает система RDoc . Поэтому я хотел бы понять, что означает значение «хэш», когда официальная документация ссылается на строку 7:

1. Имена классов, исходных файлов и любые имена методов, содержащие подчеркивание или предшествует хэш персонаж автоматически гиперссылка с комментария к их описание.

Можете ли вы привести пример того, как я это прокомментировал? Есть ли у вас какие-либо советы по использованию?

---

BTW : Есть ли у вас ресурс "MUST READ" со ссылкой на RDoc? Если да, можете ли вы это предоставить?

Answer 1

Они означают символ #.

Когда вы ссылаетесь на метод в тексте, вы обычно добавляете к нему хеш.Например: «Чтобы преобразовать массив в строку, вызовите #to_s».Теперь rdoc заметит хеш и превратит его в ссылку на документацию для метода to_s.