YARD:如何创建类方法的链接?

时间:2013-01-11 07:52:44

标签: ruby-on-rails ruby documentation yard

如何使用YARD创建指向ruby 类方法的链接?以下是有关链接的yard documentation

链接到同一命名空间中的实例方法

{#my_instance_method}

哪个工作正常。但是,遵循与类方法相同的方法不会编译和修改它:

{#self.my_class_method}

生成以下纯文本(不是链接):

ObjectName#self#self.my_class_method

2 个答案:

答案 0 :(得分:10)

只需使用名称,裸:

{class_method}

或者它是否在不同的命名空间

{Object.class_method}

答案 1 :(得分:4)

使用点。

{.class_method}

或者,如果您使用markdown作为处理器,则需要转义下划线。

{.class\_method}