Документирование классов с использованием маркированных списков - PullRequest
1 голос
/ 27 июня 2011

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

#[EXAMPLE 1 - Some text.]
#
#  [CASE 1 - Some text.]
#  
#    class User < ActiveRecord::Base
#      has_many :account,
#        :class_name  => 'User::Account',
#        :foreign_key => 'account_id'
#    end

При создании документации для моего приложения вышеупомянутый закомментированный код оставит class User < ActiveRecord::Base и end части вне блока абзаца, где они должны появиться.

Ниже приведен соответствующий снимок экрана:

enter image description here

Как я могу решить это?

Я получаю тот же вывод (за пределами блока абзаца, где должен появиться оператор класса), если я использую это

#[Example 1 - Some text.]
#  
#  class User < ActiveRecord::Base
#    has_many :account,
#      :class_name  => 'User::Account',
#      :foreign_key => 'account_id'
#  end

или это

#class User < ActiveRecord::Base
#  has_many :account,
#    :class_name  => 'User::Account',
#    :foreign_key => 'account_id'
#end

1 Ответ

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

Вы оставили только три пробела между # и словами для этих двух строк.Они должны быть минимум четырьмя пробелами.Сделайте отступ во всех строках кода еще на один пробел, и он должен работать.

...