javascript @param和@return注释中的感叹号表示什么?

问题描述 投票:1回答:1

我正在尝试关注this guideline

/** A class that does something. */
class SomeClass extends SomeBaseClass {
  /**
   * Operates on an instance of MyClass and returns something.
   * @param {!MyClass} obj An object that for some reason needs detailed
   *     explanation that spans multiple lines.
   * @param {!OtherClass} obviousOtherClass
   * @return {boolean} Whether something occurred.
   */
  someMethod(obj, obviousOtherClass) { ... }

  /** @override */
  overriddenMethod(param) { ... }
}

/**
 * Demonstrates how top-level functions follow the same rules.  This one
 * makes an array.
 * @param {TYPE} arg
 * @return {!Array<TYPE>}
 * @template TYPE
 */
function makeArray(arg) { ... }

而且我想知道感叹号在@param {!MyClass}@return {!Array<TYPE>}中的含义以及何时使用它。

javascript comments jsdoc
1个回答
2
投票

根据Use JSDoc: @type上的表,在“不可为空的类型”的行中,前面的感叹号表示“不可为空”。

© www.soinside.com 2019 - 2024. All rights reserved.