在YRI中显示自定义标签

时间:2013-08-16 01:34:02

标签: ruby yard

我在.yardopts文件中创建了一些自定义标签,如下所示:

--name-tag optfield:"Field that is not required to be filled out by the user."
--name-tag nonfield:"Parameter that is not a field to be filled out by the user."

当我在网络浏览器中查看它们时,它们显示得非常好,但是当我尝试使用yri查看某个类时,我看不到我的自定义标记显示。

例如,这个类

#This is a boring class
class Boring
    # This function is the index.
    # @param required_field [String] Required!
    # @optfield optional_argument [String] Totally not required dude.
    # @nonfield webData [WebData] Not even an option.
    def index(optional_argument = "", webData = $wedData)
    end
end

当我运行yri

时,在yri Boring#index中显示为此内容
------------------------------------------------ Method: #index (Boring)
                                               (Defined in: YardTest.rb)

    boring.index(optional_argument = "", webData = $wedData) -> Object 
------------------------------------------------------------------------

    This function is the index. 

Parameters:
-----------

    (String) required_field - Required!

有没有办法配置yri来显示我的自定义标签?

0 个答案:

没有答案