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

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忽略了标记并将类名视为简单字符串.

我知道院子里有@see标签,但是这会在文档中创建一个单独的"See Also"部分,而我需要在我的描述文本中引用类/模块.

我肯定错过了一些东西,但如果你有任何关于如何用院子做的例子,我真的很感激.

谢谢你的推荐,

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
##