码以及文档中类/模块的链接

Question

我目前正在从 rdoc 切换到yard 来保存我的 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标签，但是这将在文档中创建一个单独的“另请参阅”部分，而我需要在描述文本中引用类/模块。

我肯定错过了一些东西，但是如果您有任何关于如何使用yard 完成此操作的示例，我将非常感激。

感谢您的建议，

dl

Answer 1

引用文档：

YARD 支持特殊语法来链接到其他代码对象或文件。语法为{ObjectName#method OPTIONAL_TITLE}。此语法在文档中的任何位置都可以接受，但 @see 标记除外，该标记会自动链接其数据。

所以，你想要

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