javascript - 如何在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 supports 3 main forms of formatting your documentation. 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)
 * 
 */