码和文档中的类/模块的链接

Question

我目前正在从rdoc切换到我的ruby软件文档。

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

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

RDOC正确地创建了一个链接到Mysoft :: mypackage的::工具:: Logger类文档页面的同时，院子忽略标签并认为类名称是简单的字符串。

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

我肯定错过了一些东西，但如果你有任何关于如何在院子里完成的例子，我会非常感激。每advace

感谢，

DL

Answer 1

答曰the documentation：

YARD支持一种特殊的语法链接到其他代码对象或文件。语法是{ObjectName#method OPTIONAL_TITLE}。除了@see标签之外，该文档中的任何位置都可以使用该语法，该标签会自动链接其数据。

所以，你要

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