Документирование констант и методов - PullRequest
Новая
       36

Документирование констант и методов

0 голосов
/ 27 июня 2011

Я пишу документацию для моего приложения Ruby on Rails 3.0.7, используя RDoc.В папке приложения lib у меня есть следующее: 

module ModuleName
  class ModuleName::User < ActiveRecord::Base
    #'CONSTANT' documentation text
    CONSTANT = 'Test constant'

    #'method_name' documentation text
    def method_name
      ...
    end
  end
end

Когда я пытаюсь сгенерировать документацию для кода выше, RDoc не будет анализировать #'CONSTANT' documentation text и #'method_name' documentation text, поэтомуВыходная документация пуста.

1.Как я могу заставить RDoc рассматривать прокомментированный код в модуле «context»?

Не поможет, если я использую директиву :doc: следующим образом: 

module ModuleName #:doc:
  class ModuleName::User < ActiveRecord::Base #:doc:
    #'CONSTANT' documentation text
    CONSTANT = 'Test constant' #:doc:

    #'method_name' documentation text
    def method_name #:doc:
      ...
    end
  end
end

Я отмечаю, что они есть в Class \ Module Index : 

ModuleName
ModuleName::ModuleName
ModuleName::ModuleName::ModuleName
ModuleName::ModuleName::ModuleName::User

2.Что они означают?

...