JSDoc + Mongoose: jak dokumentować modele Mongoose?

Question

mam Mongooseschematu a modelu:

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

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

Jak udokumentować (używając JSDoc) MyClient i/lub MyClientSchema dostać kartę uzupełniania i wpisać propozycje od WebStorm dla obu metod odziedziczonych od mongoose.model, takich jak remove, findOne, find - i odziedziczonych po schemacie - takich jak phone_number and first_name?

Answer 1

Chociaż może nie zmieścić się na konkretny wymóg ten poradnik JetBrains w oficjalnej dokumentacji wyjaśnia, większość tego, co trzeba

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

na przykład

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

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

i następujące js może być wskazówką, aby zrobić prawie wszystko, czego potrzebujesz:

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