Как автоматически документировать метапрограммированные attr_accessors с помощью RDoc?

Question

FIRST, я хотел бы настроить RDoc таким образом, что он автоматически распознает каждый ключ attrs хэша foo и bar следующего код:

class SomeClass 
    def initialize(args = { }) 
    attrs = { 'foo' => nil, 
       'bar' => 'us'} 
    attrs.each_key{ |key| (class << self; self; end).send(:attr_accessor, key.to_sym)} 

    attrs.each_key do |key| 
     attrs[ key] = args[ key] if(args.has_key?(key)) 
     raise "No #{key} defined" if(attrs[key] === nil)) 
    end 

    attrs.each {|key, value| instance_variable_set("@#{key}", value)} 
    end 
end 

Как будто я инициализируюсь их следующим образом:

class SomeClass 
    attr_accessor :foo, :bar 
    def initialize(foo = nil, bar = 'us') 
     raise "No foo defined" if(foo === nil)) 
     @foo = foo 
     @bar = bar 
    end 
end 

я могу сделать следующее и имеют аксессоров показать правильно, как Attributes:

class SomeClass 
    ## 
    # :attr_accessor: foo 

    ## 
    # :attr_accessor: bar 

    ## 
    # this is a comment for a the initialize method 

    def initialize(args = { }) 
    attrs = { 'foo' => nil, 
       'bar' => 'us'} 
    attrs.each_key{ |key| (class << self; self; end).send(:attr_accessor, key.to_sym)} 

    attrs.each_key do |key| 
     attrs[ key] = args[ key] if(args.has_key?(key)) 
     raise "No #{key} defined" if(attrs[key] === nil)) 
    end 

    attrs.each {|key, value| instance_variable_set("@#{key}", value)} 
    end 
end 

Но я хотел бы иметь возможность автоматически распознавать RDoc!

ВТОРОЙ, я хотел бы быть в состоянии сделать комментарий, касающийся их определений в имении, подобную следующей и иметь комментарии отображаются в документации:

class SomeClass 
    def initialize(args = { }) 
    attrs = { 
       ## 
       #This stores your Foo 
       'foo' => nil, 
       ## 
       #This stores your Bar 
       'bar' => 'us'} 
    attrs.each_key{ |key| (class << self; self; end).send(:attr_accessor, key.to_sym)} 

    attrs.each_key do |key| 
     attrs[ key] = args[ key] if(args.has_key?(key)) 
     raise "No #{key} defined" if(attrs[key] === nil)) 
    end 

    attrs.each {|key, value| instance_variable_set("@#{key}", value)} 
    end 
end 

НАКОНЕЦ, я хотел бы их по умолчанию значения автоматически перечисляются (т.е. в документации, которую он будет перечислять, с атрибутами, которые по умолчанию foo = nil и bar = 'us').

Я изучал документацию RDoc для парсера кода Ruby RDoc::Parser::Ruby, и я хотел бы создать плагин, как описано в RDoc Developer Introduction, но я не уверен, как начать работу.

1) Есть ли что-то, что уже выполняет то, что я описал? 2) Если ничего не существует, может ли кто-нибудь указать мне пример плагина, выполняющего аналогичные функции?

Answer 1

Определите доменный язык (DSL) и используйте Yard Macro Expansion Variables.

Смотри также другие мои родственные вопросы:

• Iterating over the registers of a Yardoc @macro
• How to make Yard @macros apply to multiple files
• Dynamic documentation, using the return of method in the description of another YARD?
• Ruby DSLs and Dynamic Documentation?