0

RDoc を使用して、Ruby on Rails 3.0.7 アプリケーションのドキュメントを作成しています。アプリケーションlibフォルダーには、次のものがあります。

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

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

#'CONSTANT' documentation text上記のコードのドキュメントを生成しようとすると、RDoc は と を解析しない#'method_name' documentation textため、出力ドキュメントは空白になります。

1. モジュール「コンテキスト」内のコメント化されたコードを RDoc で考慮するにはどうすればよいですか?

: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. どういう意味ですか?

4

0 に答える 0