JSDoc + Mongoose：どのようにMongooseモデルを文書化しますか？

Question

私はMongooseスキーマ持ち、モデル：私はタブ補完を取得し、継承された両方の方法についてWebStormからの提案を入力しMyClientおよび/またはMyClientSchemaを（JSDocのを使用して）文書化する必要がありますどのように

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

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

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