Question

我有一段这样的代码：

//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和其他网站上搜索，但没有什么是真正有用的。抱歉英文不好。

Answer 1

使用@memberof标记标识符。请参阅文档和使用示例：JSDoc @memberof

你也可以使用@alias来排除＆＃34; prototype＆＃34;从您的文档。用法示例和文档：JSDoc @alias

VS Code - 如何使用JSDoc来记录原型方法和属性

1 个答案: