Добавление документации для областей видимости модели в рельсы

Я не уверен, возможно ли это на самом деле или нет, но я пытаюсь сделать документацию нашего приложения rails более полной, добавив документацию по областям действия в наше app / файлы моделей . Я хочу попробовать и сделать следующее:

# This is a description of what the scope does and the action that it performs
scope :newest_records, order("created_at desc").limit(50)

А затем, когда я запускаю rdoc в приложении, я хочу, чтобы видел newest_records , перечисленных как метод общедоступного класса вместе с другими традиционные методы, которые будут задокументированы, например:

# some more documentation about this method
def self.a_class method
  ....
end

РЕДАКТИРОВАТЬ

Я понимаю, что этот вопрос может быть немного двусмысленным. Итак, вот попытка уточнить: в настоящее время, когда я пытаюсь добавить строку комментария над объявлением scope , я не получаю НИКАКОЙ документации, созданной RDoc для этой области. Я знаю, что RDoc может получать мета-методы / атрибуты, иначе он не будет отображать атрибуты в документах, которые объявлены с помощью attr_accessor . Итак, мой вопрос: как мне добавить комментарии к моему файлу, чтобы:

  • Метод появился в моей документации, созданной RDoc
  • Он появился как метод открытого класса (в отличие от метода открытого экземпляра и т. Д.)
8
задан Chris Bailey 2 September 2011 в 11:17
поделиться