ruby - 院子和文档中的类/模块的链接

Question

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

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

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

Rdoc 正确地创建了指向 Mysoft::Mypackage::Utility::Logger 类文档页面的链接，而 yard 忽略了标记并将类名视为简单字符串。

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

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

感谢您的建议，

dl

score 41 · Accepted Answer

引用文档：

YARD 支持一种特殊的语法来链接到其他代码对象或文件。语法是{ObjectName#method OPTIONAL_TITLE}. 这种语法在文档中的任何地方都可以接受，但@see标签除外，它会自动链接其数据。

所以你要

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

1 回答 1