院子并链接到文档中的类/模块

Question

我目前正在从RDOC切换到Ruby软件文档。

在我的文档中，我经常从评论中引用一些类/模块，例如：

## == Provides various utility features
##
## == Features
##
## Logging : logging is provided by the Mysoft::Mypackage::Utility::Logger class
##

RDOC正确地创建了指向MySoft :: mypackage :: Utility :: Logger类文档页面的链接，而Yard却忽略了标签并将类名为“简单字符串”。

我知道Yard具有@See标签，但是这将在文档中创建一个单独的“请参见”部分，而我需要用内部的描述文本引用类/模块。

我肯定会错过一些东西，但是如果您有任何有关如何使用院子做的例子，我会非常感谢。

感谢Per Advace，

DL

Answer 1

Quoth 文档:

院子支持一种特殊的语法，以链接到其他代码对象或文件。语法是 {ObjectName#method OPTIONAL_TITLE}. 。此语法在文档中可以接受，除了 @see 标签，该标签自动链接其数据。

所以你要

## == Provides various utility features
##
## == Features
##
## Logging: logging is provided by the {Mysoft::Mypackage::Utility::Logger} class
##