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

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标签，但是这将在文档中创建一个单独的“参见”部分，而我需要在我的描述文本中引用类/模块。我肯定缺少了什么，如果您有任何使用yard完成此操作的示例，我将非常感激。提前致谢，dl

- devlearn

Answer 1

引用文档：

YARD支持一种特殊的语法来链接其他代码对象或文件。该语法是{ObjectName#method OPTIONAL_TITLE}。该语法在文档中任何地方都可以使用，但不包括@see标签，因为它会自动链接其数据。

所以，你想要：

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

- Jörg W Mittag

---

谢谢！你是在代码中查找还是有比 http://rubydoc.info/docs/yard/file/docs/GettingStarted.md 更好的参考文档？ - devlearn