JSDoc - 如何分配功能作爲另一個功能

Question

給出下面，當我運行jsdoc，輸出不顯示爲foo.bar任何財產的屬性。

/** 
* Foo 
*/ 
const foo = function foo() { 
    //... 
} 

/** 
* Bar 
*/ 
foo.bar = function bar() { 
    //... 
} 

如何顯示bar爲上foo的屬性？

Answer 1

有很多的可能性，以實現這一目標。以下只是他們夫婦...

• 使用@memberof這是標籤標識屬於父符號的成員符號。

  /** 
  * Foo 
  */ 
  const foo = function foo() { 
      //... 
  } 
  
  /** 
  * Bar 
  * @memberof Foo 
  */ 
  foo.bar = function bar() { 
      //... 
  } 
  

• 使用@prop這是爲了方便地記錄類，命名空間或其它物體的靜態屬性列表的標籤。

  /** 
  * Foo 
  * @namespace 
  * @property {object} bar - is this "bar" property? 
  */ 
  const foo = function foo() { 
      //... 
  } 
  
  /** 
  * Bar 
  */ 
  foo.bar = function bar() { 
      //... 
  } 
  

您可以使用@alias爲好，這一切都取決於你是什麼Foo和酒吧;他們是對象，命名空間，功能，性能等，我建議閱讀JSDoc文檔有點結識做好一切準備。