Object.defineProperties aracılığıyla eklenen örnek üyelerini doğru şekilde nasıl belgeleyebilirim?

Question

Object.defineProperties aracılığıyla birkaç örnek özelliğini tanımlayan bir sınıfa sahibim ve sınıflarına ait olduklarını anlamak için JSDoc 3 almakta zorlanıyorum.

İşte Birlikte çalıştığım şeyi basitleştirilmiş versiyonu: Ben JSDoc çalıştırdığınızda

/** @exports mymodule */ 
function mymodule(exports) { 
    /** @constructor 
     * @param {String} foo A foo. 
     * @param {String} bar A bar. 
     * @classdesc Has a foo and a bar. 
     */ 
    function Example(foo, bar) { 
     Object.defineProperties(this, { 
      /** A foo and a bar 
       * @memberof Example 
       */ 
      foobar: { enumerable: false, value: foo + bar, writable: false } 
     }); 
    } 

    exports.Example = Example; 
} 

, ben mymodule, Example, foo ve bar değil foobar için çıkış olsun. etiketini foobar için kaldırırsam, genel olarak kayıtlı olur. @lends ekleyerek @memberof mymmodule~Example denedim, hem Object.defineProperties aramasına hem de ona geçirilen nesneyi ve Object.defineProperty dönüştürerek, ancak sonuçlar değişmez.

foobar'u Example'a ait olarak nasıl belgeleyebilirim?

Answer 1

Bulduğum her örnekte kazandıktan sonra, sonunda gerekli olan ilaveyi bir araya getirdim - @memberof gerçekten hiledir, ancak JSDoc, namepathlarda kullanılan modüllerin açık bir şekilde işaretlenmesini gerektiriyor gibi görünüyor. Aşağıdaki mükemmel çalıştı:

/** A foo and a bar 
    * 
    * @type String 
    * @instance 
    * @memberof module:mymodule~Example 
    */ 

Answer 2

saatlerce uğraşırsanız sonra nihayet o @memberOf! çalışmak lazım. Büyük harf "O" ve patlama "!"

/** 
* Description 
* @memberOf! MyClass 
* @type {String} 
*/ 
var myString; 

Answer 3

Ayrıca böyle @memberOf yerine @lends ek açıklama deneyebilirsiniz:

Object.defineProperties(this, /** @lends Example# */{ 
    /** A foo and a bar */ 
    foobar: { enumerable: false, value: foo + bar, writable: false } 
}); 

jsdoc üyelerinin örnek üyeleri ve olmayan anlatmak için sınıf adından sonra keskin sembolü unutma Statik üyeler