如何在yuidoc中添加添加外部链接(grunt contrib yuidoc)

Question

我想我在yuidoc文档中遗漏了一些内容或误解了用法。我似乎找不到在文档中包含外部网站/页面链接的方法。

在评论区，我想要这样的东西：

/**
 * Creates a blah-blah for blah-blahing blah.
 * 
 * @constructor
 * @param {object} blah
 *
 * Follow recommendations at:
 * @link <a href="http://blah.com/boop">Boop</a>
 */

Answer 1

根据文件显示：

YUIDoc支持格式化文档的三种主要形式。HTML，Markdown&Selleck。

所以你可以像这样使用HTML或Markdown：

/**
 * Creates a blah-blah for blah-blahing blah.
 * 
 * @constructor
 * @param {object} blah
 *
 * Follow recommendations at:
 * <a href="http://blah.com/boop">Boop</a>
 * Or
 * [Boop](http://blah.com/boop)
 * 
 */