2015-04-14 118 views
4

是否有任何自然的方式或特殊的標籤來使參數類型成爲鏈接? enter image description here如何在jsDoc中創建方法參數類型的鏈接

/** 
* My js app 
* @module app 
*/ 
/** 
* Namespace for MYAPP classes and functions. 
* @namespace HUMAN_RESOURCE 
*/ 
var HUMAN_RESOURCE = HUMAN_RESOURCE || {}; 

/** 
* @class JustClass 
* @constructor 
*/ 
HUMAN_RESOURCE.JustClass = function(){ } 

/** 
* Constructs Person objects 
* @class Person 
* @constructor 
* @param {String} First name 
* @param {String} Last name 
*/ 
HUMAN_RESOURCE.Person = function (first, last) {  
    /** 
    * First name of the Person 
    * @property first_name 
    * @type String 
    */ 
    this.first_name = first; 

    /** 
    * @property f_createPerson 
    * @param {Person} [_person] açıklama 
    * @return {Person} Person type object 
    */ 
    this.f_createPerson = function(_person, _person2){ return new Person() } 
}; 

/** 
* Return Person's full name 
* @alias getName 
* @memberof! HUMAN_RESOURCE.Person# 
* @return {String} First name + last name 
*/ 
HUMAN_RESOURCE.Person.prototype.getName = function() { 
    return this.first_name + ' ' + this.last_name; 
}; 

回答

6

幸運的是,這只是並不總是顯而易見的正確名稱的路徑是什麼(但你基本上可以看到它在你生成的文檔的頂部)

/** 
* @property f_createPerson 
* @param {module:app~HUMAN_RESOURCE.Person} [_person] açıklama 
* @return {module:app~HUMAN_RESOURCE.Person} Person type object 
*/ 
this.f_createPerson = function(_person, _person2){ return new Person() } 
+1

然而JSdoc3的另一特點這需要簡化。「(@link MyModule#aMethod)' – LeeGee