如何在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支持3种格式化文档的主要形式.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)
 * 
 */