簡體   English   中英

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

[英]How to add add external links in 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>
 */

根據文件說:

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)
 * 
 */

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM