JSDoc + Mongoose: как документировать модели Mongoose?

Question

У меня есть Mongooseсхемы и модель:

var MyClientSchema = new mongoose.Schema({ 
    fist_name: { 
     type: String 
    }, 
    phone_number: { 
     type: String 
    } 
}); 

var MyClient = mongoose.model('MyClient', MyClientSchema); 

Как следует документировать (используя JSDoc) MyClient и/или MyClientSchema получить вкладку автозавершение и введите предложения от WebStorm для обоих методов, унаследованных от mongoose.model как remove, findOne, find - и унаследовано от схемы - например phone_number and first_name?

Answer 1

Хотя это может и не соответствовать вашим конкретным требованиям, это реактивные мозги учебник в официальной документации объясняет большинство того, что вам нужен

https://www.jetbrains.com/help/webstorm/2017.1/creating-jsdoc-comments.html

, например,

/** 
* MyClientSchema schema 
* @constructor MyClient 
*/ 

var MyClientSchema = new mongoose.Schema({ 
     fist_name: { 
      type: String 
     }, 
     phone_number: { 
      type: String 
     } 
    }); 

и следующий JS может быть гидом для вас, чтобы сделать практически все, что вам нужно

http://nagyv.github.io/estisia-wall/models.js.html