局部变量的正确 JSDoc 语法是什么？

Question

对于这样的函数...

function example() {
  var X = 100;

  ...

  var Y = 'abc';

  ...

  return Z;
}

我需要解释一些局部变量的用途。添加这样的描述...

function example() {
  /**
   * @description - Need to explain the purpose of X here.
   */
  var X = 100;

  ...

  /**
   * @description - Need to explain the purpose of Y here.
   */
  var Y = 'abc';

  ...

  return Z;
}

...似乎没有被 JS Doc v3.4.0 选中。

正确的语法是什么？

P.S。我的一些用例需要多行注释。

Answer 1

我通常在我的项目中使用类似于下面的代码。

function example() {
  /**
   * Need to explain the purpose of X here.
   * @type {number}
   */
  var X = 100;

  ...

  /**
   * Need to explain the purpose of Y here.
   * @type {string}
   */
  var Y = 'abc';

  ...

  return Z;
}

Answer 2

似乎 JS Docs 忽略了 "block" 中的注释（例如 class、函数等）。我试过了...

@description
@inner
@instance
@member
@memberof
@name
@summary

...和其他人。我无法让他们中的任何一个生成文档。在整个 JS Doc 示例中，他们对这类事情使用普通的 JS 注释。

我得出结论，没有官方的 JS Doc 语法。

Answer 3

一个班轮：

  /** @type {string} */
  let Y = 'abc';

Answer 4

对我最有用的东西：

/**
  * @name AssetAutoGenerationOption
  * @type {"all" | "master" | "off"}
  */
export type AssetAutoGenerationOption = "all" | "master" | "off";

Answer 5

您可能会使用：

/**
 * @function
 * @property {number} x - Need to explain the purpose of X here.
 * @property {number} y - Need to explain the purpose of Y here.
 * @returns {number} - Describe return value here (assumed number type for this example)
 */
function example() {
  var x
  var y = 'abc';
  return z;
}

局部变量的正确 JSDoc 语法是什么？

What is the correct JSDoc syntax for a local variable?

javascript

jsdoc

jsdoc3