VS Code - 如何使用 JSDoc 记录原型方法和 属性
VS Code - How to use JSDoc to document a prototype methods and property
我有一段代码是这样的:
//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 查看属性或方法的描述和可能的类型。
我之前曾尝试在 Whosebug 和其他网站上进行搜索,但没有任何帮助。
抱歉英语不好。
使用@memberof 标记标识符。请参阅文档和用法示例:JSDoc @memberof
您可能还想使用@alias 从您的文档中排除"prototype"。使用示例和文档:JSDoc @alias
我有一段代码是这样的:
//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 查看属性或方法的描述和可能的类型。 我之前曾尝试在 Whosebug 和其他网站上进行搜索,但没有任何帮助。 抱歉英语不好。
使用@memberof 标记标识符。请参阅文档和用法示例:JSDoc @memberof
您可能还想使用@alias 从您的文档中排除"prototype"。使用示例和文档:JSDoc @alias