有没有办法强制 RDoc 不设置对应于 类 或模块的单词的样式？

Question

我正在尝试使用 RDoc 将文档写入我的 类 之一，但遇到以下问题：

这是我的来源：

module Native
  module Facebook
    # Service, which starts(schedules) Native Facebook Fetching Jobs for users with Facebook platform.
    #
    # *IMPORTANT:* <tt>Native::Facebook::StartFetchingJobs</tt> is intended to be called only from <tt>config/schedule.rb</tt>.
    #
    # For example:
    #   # config/schedule.rb
    #   every :day, at: '7:00 pm' do
    #     runner 'Native::Facebook::StartFetchingJobs.call'
    #   end
    #
    class StartFetchingJobs < Service
      # ...

      def call
        # ...
      end

      # ...
    end
  end
end

这是生成文档的截图：

由于 Native 和 Facebook 是模块，RDoc 在生成的文档中突出显示 Native 和 Facebook 单词（绿色文本）。

那么，我的问题是 - 有没有办法强制 RDoc 不对对应于 类 或模块的词设置样式？

Answer 1

您只需在模块和 class 名称前添加一个反斜杠即可。

因此，使用 \Native 和 \Facebook 代替 Native 和 Facebook。

可以找到文档 here。在 Escaping Text Markup 部分。