是否有一种方法可以强制RDoc不对与类或模块相对应的单词进行样式设置?

问题描述 投票:0回答:1

我正在尝试使用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

这是生成的文档的屏幕截图:

enter image description here

由于NativeFacebook是模块,所以RDoc在生成的文档中突出显示NativeFacebook词(用绿色文本表示。)>

所以,我的问题-是否有一种方法可以强制RDoc不对与类或模块相对应的单词进行样式设置?

我正在尝试使用RDoc将文档写到我的一个类中,并且我遇到以下问题:这是我的源代码:模块本机模块Facebook#Service,它会启动(计划)本机...

ruby documentation-generation rdoc
1个回答
0
投票
您需要做的就是在模块和类名的前面加上反斜杠。
© www.soinside.com 2019 - 2024. All rights reserved.