加载中...

@instance


描述: 记录一个实例成员。

Overview(概述)

使用@instance标签标明该标识符作为它父标识符的实例成员。这意味着它可以通过"Parent#Child"被引用。

使用@instance将重写的doclet的默认范围(除非它是全局性的,在这种情况下将保持全局性)。

Examples(例子)

下面的例子是"@function MyNamespace#myFunction"的一个普通写法。

例如,使用 @instance 使一个虚拟的doclet作为实例成员,例如:

  1. /** @namespace MyNamespace */
  2. /**
  3. * myFunction is now MyNamespace#myFunction.
  4. * @function myFunction
  5. * @memberof MyNamespace
  6. * @instance
  7. */

更有用的情况是,你可以使用@instance标签覆盖JSDoc推断的范围。例如,您可以指明一个静态成员被用作一个实例成员:

例如,使用@instance确定一个实例成员:

  1. /** @namespace */
  2. var BaseObject = {
  3. /**
  4. * foo is now BaseObject#foo rather than BaseObject.foo.
  5. * @instance
  6. */
  7. foo: null
  8. };
  9. /** Generates BaseObject instances. */
  10. function fooFactory(fooValue) {
  11. var props = { foo: fooValue };
  12. return Object.create(BaseObject, props);
  13. }

还没有评论.