在YARD注释中引用其他文档的自由格式标签?

时间:2018-11-25 07:34:21

标签: ruby documentation yard

我需要能够将源于Ruby代码的YARD文档中的标签(具体来说是普遍存在的语言术语)链接到外部文档中的标签定义。如果我能然后交叉引用那些链接,那就太神奇了。

我定义了以下@macro:

# @!macro term
#   {file:UBIQUITOUS-LANGUAGE.md#${2--1} ${2--1}}

当我引用该宏时,例如

# ...an (@term Entity) representing the contents of the newly-added record...

它不产生任何输出,也没有来自yardoc解析器的警告。

帮助?

0 个答案:

没有答案