記錄類中的屬性名稱空間

如何記錄類中的屬性名稱空間？記錄類中的屬性名稱空間

/** 
* @constructor User 
* @param forename 
* @param surname 
*/ 
function User(forename, surname) { 

    /** 
    * How to document such a property-namespace? 
    */ 
    this.name = { 
     /** 
     * How to document such a property? 
     */ 
     first: forename, 

     /** 
     * How to document such a property? 
     */ 
     second: surname 
    }; 

}

UPDATE：

使用@namespace和@property的工作，但它是Namespaces代替Members或Properties下顯示，並只能作爲一個鏈接，帶我到一個單獨的頁面，這是尷尬，因爲我只記錄一個班級。更糟糕的是，這樣的名稱空間也出現在全局名稱空間的列表中。看起來像一個不好的解決方案。有更好的嗎？

來源

2016-01-23 vitaly-t

你不能使用'@ namespace'，'@ memberof'和'@ property'嗎？這就是我在Google上搜索時得到的結果。 – mostruash

@mostruash那麼包含的屬性呢？ –

@mostruash確實有用，但帶我到一個單獨的命名空間文檔頁面，這很尷尬，因爲它是我正在記錄的同一個類。 –

這工作：

/** 
* @constructor User 
* @param forename 
* @param surname 
*/ 
function User(forename, surname) { 

    /** 
    * @member {Object} User.name 
    * 
    * @property {String} forename 
    * 
    * @property {String} surname 
    */ 
    this.name = { 
     forename: forename, 
     surname: surname 
    }; 

}

感謝@mostruash！

來源

2016-01-23 15:45:37

記錄類中的屬性名稱空間

回答

相關問題