javascript - 如何在 yuidoc (grunt-contrib-yuidoc) 中添加外部链接
我想我可能在 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>
*/
答案#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)
*
*/
