2014-04-27 1 views
6

나는 yuidoc 문서에서 뭔가를 놓치고 있거나 사용법을 잘못 이해하고 있다고 생각합니다. 내 문서에 외부 사이트/페이지에 대한 링크를 포함시키는 방법을 찾지 못하는 것 같습니다. 주석 블록에서 yuidoc (grunt-contrib-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> 
*/ 

답변

7

말한다 :

YUIDoc는 문서 포맷의 3 개 주요 형태를 지원합니다. HTML, Markdown & Selleck.

그래서 당신은 다음과 같이 HTML 또는 마크 다운을 사용할 수 있습니다

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