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文档有点结识做好一切准备。