2017-03-03 85 views
0

我有這樣一段代碼:VS碼 - 如何使用JSDoc記錄原型的方法和屬性

//line 0 

/** 
* Constructor of class Person 
* @class 
* @constructor 
* @param {string} name Name of person 
* @param {string} surname Surname of person 
* @param {number} age Age of person 
*/ 
function Person(name, surname, age){ 
    this.name = name; 
    this.surname = surname; 
    this.age = age; 
} 


/** Optional for my project, MISSING JSDOC */ 
Person.prototype = { 
    //..somethings.. 

    /** MISSING JSDOC */ 
    talk: function(){ 
     //..somethings.. 
    }, 

    /** MISSING JSDOC */ 
    walk: function(){ 
     //..somethings.. 
    }, 

    /** MISSING JSDOC */ 
    foo: function(){ 
     //..somethings.. 
     p.bar(); 
     //..somethings.. 
    } 
}; 

/** 
* A shortcut to access to {@link Person} methods' more easly 
* @type {Object} p 
*/ 
var p = Person.prototype; 

//something else 

但我不知道該怎麼評論的.prototype對象看,與IntelliSense,說明和可能的屬性或方法的類型。 我已經嘗試過在StackOverflow和其他網站上搜索,但沒有什麼是真正有用的。 對不起,英語不好。

回答

0

使用@memberof標籤標識符。請參閱文檔和使用示例:JSDoc @memberof

您可能還想使用@alias以從文檔中排除「prototype」。使用示例和文檔:JSDoc @alias

+0

@memberof不縫與vscode salsa/intellisense一起使用,並且未在typescript支持的jsdoc標記中列出 – Hurelu