【问题标题】:what does an exclamation mark indicate in javascript @param and @return comments?javascript @param 和 @return 注释中的感叹号表示什么?
【发布时间】:2020-08-16 22:18:38
【问题描述】:

我正在尝试关注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&lt;TYPE&gt;}中的感叹号是什么意思以及何时使用它。

【问题讨论】:

  • jsdoc.app/tags-type.html - “Non-nullable type” - 前面的感叹号似乎表示“non-null”。
  • @ASDFGerte 谢谢。您可以将其发布为答案吗?

标签: javascript comments jsdoc


【解决方案1】:

根据Use JSDoc: @type上的表格,在“Non-nullable type”行,前面的感叹号表示“non-null”。

【讨论】:

    猜你喜欢
    • 2013-04-25
    • 2011-12-22
    • 2020-09-23
    • 2020-05-26
    • 2014-03-16
    • 2018-11-14
    • 2022-07-26
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多